Database.h

Go to the documentation of this file.

/////////////////////////////////////////////////////////////////////////////
//
// This code was automatically generated by the joedb compiler
// https://www.joedb.org/
//
// Path to compiler: /home/rcoulom/repos/joedb/compcmake/gcc_debug/joedbc
// Version: 9.5.0
// joedbc compilation time: May  5 2025 19:51:43
// Generation of this file: 2025-05-05 17:51:47 GMT
//
/////////////////////////////////////////////////////////////////////////////
#ifndef joedb_db_encoded_file_Database_declared
#define joedb_db_encoded_file_Database_declared
 
#include "joedb/Freedom_Keeper.h"
#include "joedb/journal/Writable_Journal.h"
#include "joedb/journal/Memory_File.h"
#include "joedb/error/Exception.h"
#include "joedb/error/Out_Of_Date.h"
#include "joedb/error/assert.h"
#include "joedb/get_version.h"
#include "ids.h"
 
#include <string>
#include <cstdint>
#include <cstring>
#include <vector>
#include <algorithm>
#include <string_view>
 
static_assert(std::string_view(joedb::get_version()) == "9.5.0");
 
namespace joedb::db::encoded_file
{
 /// @namespace joedb::db::encoded_file
 ///
 /// Automatically generated by joedbc
 
 using joedb::Record_Id;
 using joedb::Table_Id;
 using joedb::Field_Id;
 
 namespace detail
 {
  extern const char * schema_string;
  inline constexpr size_t schema_string_size = 75;
 }
 class container_of_buffer;
 
 namespace detail
 {
  struct data_of_buffer
  {
   std::vector<joedb::Blob> field_value_of_data;
   std::vector<int64_t> field_value_of_size;
   std::vector<int64_t> field_value_of_offset;
 
   joedb::Compact_Freedom_Keeper freedom_keeper;
 
   size_t size() const {return freedom_keeper.size();}
 
   void resize(size_t new_size)
   {
    field_value_of_data.resize(new_size);
    field_value_of_size.resize(new_size);
    field_value_of_offset.resize(new_size);
    freedom_keeper.resize(new_size);
   }
  };
 }
 
 
 /// Store all the tables of the database
 class Database: public joedb::Writable
 {
  friend class Readable;
  friend class id_of_buffer;
  friend class container_of_buffer;
 
  public:
   template<typename E = joedb::Exception>
   static void throw_exception(const std::string &message)
   {
    throw E("joedb::db::encoded_file: " + message);
   }
 
   size_t max_record_id;
   Table_Id current_table_id = Table_Id{0};
 
   void set_max_record_id(size_t record_id)
   {
    max_record_id = record_id;
   }
 
   bool is_valid(id_of_buffer id) const {return is_valid_record_id_for_buffer(id.get_record_id());}
 
  protected:
   detail::data_of_buffer storage_of_buffer;
   bool is_valid_record_id_for_buffer(Record_Id record_id) const {return storage_of_buffer.freedom_keeper.is_used(size_t(record_id) + 1);}
 
   void internal_delete_buffer(Record_Id record_id)
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id));
    storage_of_buffer.field_value_of_data[size_t(record_id) - 1] = joedb::Blob();;
    storage_of_buffer.field_value_of_size[size_t(record_id) - 1] = 0;
    storage_of_buffer.field_value_of_offset[size_t(record_id) - 1] = 0;
    storage_of_buffer.freedom_keeper.free(size_t(record_id) + 1);
   }
 
   void internal_insert_buffer(Record_Id record_id)
   {
    storage_of_buffer.freedom_keeper.use(size_t(record_id) + 1);
   }
 
   void internal_vector_insert_buffer(Record_Id record_id, size_t size)
   {
    storage_of_buffer.freedom_keeper.use_vector(size_t(record_id) + 1, size);
   }
 
   void internal_update_buffer__data
   (
    Record_Id record_id,
    joedb::Blob field_value_of_data
   )
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id));
    storage_of_buffer.field_value_of_data[size_t(record_id) - 1] = field_value_of_data;
   }
 
   void internal_update_vector_buffer__data
   (
    Record_Id record_id,
    size_t size,
    const joedb::Blob *value
   )
   {
    for (size_t i = 0; i < size; i++)
     JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id + i));
    joedb::Blob *target = &storage_of_buffer.field_value_of_data[size_t(record_id) - 1];
    if (target != value)
     std::copy_n(value, size, target);
   }
 
   void internal_update_buffer__size
   (
    Record_Id record_id,
    int64_t field_value_of_size
   )
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id));
    storage_of_buffer.field_value_of_size[size_t(record_id) - 1] = field_value_of_size;
   }
 
   void internal_update_vector_buffer__size
   (
    Record_Id record_id,
    size_t size,
    const int64_t *value
   )
   {
    for (size_t i = 0; i < size; i++)
     JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id + i));
    int64_t *target = &storage_of_buffer.field_value_of_size[size_t(record_id) - 1];
    if (target != value)
     std::copy_n(value, size, target);
   }
 
   void internal_update_buffer__offset
   (
    Record_Id record_id,
    int64_t field_value_of_offset
   )
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id));
    storage_of_buffer.field_value_of_offset[size_t(record_id) - 1] = field_value_of_offset;
   }
 
   void internal_update_vector_buffer__offset
   (
    Record_Id record_id,
    size_t size,
    const int64_t *value
   )
   {
    for (size_t i = 0; i < size; i++)
     JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record_id + i));
    int64_t *target = &storage_of_buffer.field_value_of_offset[size_t(record_id) - 1];
    if (target != value)
     std::copy_n(value, size, target);
   }
 
 
   void delete_from(Table_Id table_id, Record_Id record_id) final
   {
    if (table_id == Table_Id(1))
     internal_delete_buffer(record_id);
   }
 
   void insert_into(Table_Id table_id, Record_Id record_id) final
   {
    if (size_t(record_id) <= 0 || (max_record_id && size_t(record_id) > max_record_id))
     throw_exception("insert_into: too big");
    if (table_id == Table_Id(1))
    {
     if (is_valid_record_id_for_buffer(record_id))
      throw_exception("Duplicate insert into table buffer");
     if (storage_of_buffer.size() < size_t(record_id))
      storage_of_buffer.resize(size_t(record_id));
     internal_insert_buffer(record_id);
    }
   }
 
 
   void insert_vector
   (
    Table_Id table_id,
    Record_Id record_id,
    size_t size
   ) final
   {
    if
    (
     size_t(record_id) <= 0 ||
     (max_record_id && (size_t(record_id) > max_record_id || size > max_record_id))
    )
    {
     throw_exception("insert_vector: null record_id, or too big");
    }
    if (table_id == Table_Id(1))
    {
     if (storage_of_buffer.size() < size_t(record_id) + size - 1)
      storage_of_buffer.resize(size_t(record_id) + size - 1);
     internal_vector_insert_buffer(record_id, size);
    }
   }
 
   void update_int64
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    int64_t value
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     if (field_id == Field_Id(2))
     {
      internal_update_buffer__size(record_id, value);
      return;
     }
     if (field_id == Field_Id(3))
     {
      internal_update_buffer__offset(record_id, value);
      return;
     }
     return;
    }
   }
 
   void update_blob
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    joedb::Blob value
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     if (field_id == Field_Id(1))
     {
      internal_update_buffer__data(record_id, value);
      return;
     }
     return;
    }
   }
 
   void update_vector_int64
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    size_t size,
    const int64_t *value
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     if (field_id == Field_Id(2))
     {
      internal_update_vector_buffer__size(record_id, size, value);
      return;
     }
     if (field_id == Field_Id(3))
     {
      internal_update_vector_buffer__offset(record_id, size, value);
      return;
     }
     return;
    }
   }
 
   void update_vector_blob
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    size_t size,
    const joedb::Blob *value
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     if (field_id == Field_Id(1))
     {
      internal_update_vector_buffer__data(record_id, size, value);
      return;
     }
     return;
    }
   }
 
   int64_t *get_own_int64_storage
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    size_t &capacity
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     capacity = size_t(storage_of_buffer.freedom_keeper.size());
     if (field_id == Field_Id(2))
     {
      return (storage_of_buffer.field_value_of_size.data() + size_t(record_id) - 1);
     }
     if (field_id == Field_Id(3))
     {
      return (storage_of_buffer.field_value_of_offset.data() + size_t(record_id) - 1);
     }
     return nullptr;
    }
    return nullptr;
   }
 
   joedb::Blob *get_own_blob_storage
   (
    Table_Id table_id,
    Record_Id record_id,
    Field_Id field_id,
    size_t &capacity
   )
   final
   {
    if (table_id == Table_Id(1))
    {
     capacity = size_t(storage_of_buffer.freedom_keeper.size());
     if (field_id == Field_Id(1))
     {
      return (storage_of_buffer.field_value_of_data.data() + size_t(record_id) - 1);
     }
     return nullptr;
    }
    return nullptr;
   }
 
   void comment(const std::string &comment) override {}
   void timestamp(int64_t timestamp) override {}
   void valid_data() final {}
 
   bool upgrading_schema = false;
   joedb::Memory_File schema_file;
   joedb::Writable_Journal schema_journal;
 
   bool requires_schema_upgrade() const
   {
    return schema_file.get_data().size() < detail::schema_string_size;
   }
 
   void check_schema()
   {
    constexpr size_t pos = joedb::Header::size;
    const size_t schema_file_size = schema_file.get_data().size();
 
    if
    (
     schema_file_size < pos ||
     schema_file_size > detail::schema_string_size ||
     std::memcmp
     (
      schema_file.get_data().data() + pos,
      detail::schema_string + pos,
      schema_file_size - pos
     ) != 0
    )
    {
     throw_exception("Trying to open a file with incompatible schema");
    }
   }
 
   void create_table(const std::string &name) override
   {
    ++current_table_id;
    schema_journal.create_table(name);
    schema_journal.soft_checkpoint();
   }
 
   void drop_table(Table_Id table_id) final
   {
    schema_journal.drop_table(table_id);
    schema_journal.soft_checkpoint();
   }
 
   void rename_table
   (
    Table_Id table_id,
    const std::string &name
   ) final
   {
    schema_journal.rename_table(table_id, name);
    schema_journal.soft_checkpoint();
   }
 
   void add_field
   (
    Table_Id table_id,
    const std::string &name,
    joedb::Type type
   ) override
   {
    schema_journal.add_field(table_id, name, type);
    schema_journal.soft_checkpoint();
   }
 
   void drop_field(Table_Id table_id, Field_Id field_id) final
   {
    schema_journal.drop_field(table_id, field_id);
    schema_journal.soft_checkpoint();
   }
 
   void rename_field
   (
    Table_Id table_id,
    Field_Id field_id,
    const std::string &name
   ) final
   {
    schema_journal.rename_field(table_id, field_id, name);
    schema_journal.soft_checkpoint();
   }
 
   void custom(const std::string &name) override
   {
    schema_journal.custom(name);
    schema_journal.soft_checkpoint();
   }
 
  public:
   Database():
    max_record_id(0),
    schema_journal(schema_file)
   {}
 
   int64_t get_schema_checkpoint() const
   {
    return schema_journal.get_checkpoint();
   }
 
   void initialize_with_readonly_journal(joedb::Readonly_Journal &journal)
   {
    max_record_id = size_t(journal.get_checkpoint());
    journal.replay_log(*this);
    max_record_id = 0;
 
    check_schema();
 
    if (requires_schema_upgrade())
     throw_exception<joedb::Out_Of_Date>("Schema is out of date. Can't upgrade a read-only database.");
   }
 
   container_of_buffer get_buffer_table() const;
 
   id_of_buffer next(id_of_buffer id) const
   {
    return id_of_buffer
    (
     Record_Id(storage_of_buffer.freedom_keeper.get_next(id.get_id() + 1) - 1)
    );
   }
 
   id_of_buffer previous(id_of_buffer id) const
   {
    return id_of_buffer
    (
     Record_Id(storage_of_buffer.freedom_keeper.get_previous(id.get_id() + 1) - 1)
    );
   }
 
   template<class Comparator>
   std::vector<id_of_buffer> sorted_buffer(Comparator comparator) const;
 
   static id_of_buffer null_buffer()
   {
    return id_of_buffer();
   }
 
   joedb::Blob get_data(id_of_buffer record) const
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record.get_record_id()));
    return (joedb::Blob)(storage_of_buffer.field_value_of_data[record.get_id() - 1]);
   }
 
   int64_t get_size(id_of_buffer record) const
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record.get_record_id()));
    return (int64_t)(storage_of_buffer.field_value_of_size[record.get_id() - 1]);
   }
 
   int64_t get_offset(id_of_buffer record) const
   {
    JOEDB_DEBUG_ASSERT(is_valid_record_id_for_buffer(record.get_record_id()));
    return (int64_t)(storage_of_buffer.field_value_of_offset[record.get_id() - 1]);
   }
 };
 /// returned by @ref Database::get_buffer_table
 class container_of_buffer
 {
  friend class Database;
 
  private:
   const Database &db;
   container_of_buffer(const Database &db): db(db) {}
 
  public:
   class iterator
   {
    friend class container_of_buffer;
    private:
     const joedb::Compact_Freedom_Keeper *fk;
     size_t index;
     iterator(const detail::data_of_buffer &data): fk(&data.freedom_keeper), index(0) {}
    public:
     typedef std::forward_iterator_tag iterator_category;
     typedef id_of_buffer value_type;
     typedef std::ptrdiff_t difference_type;
     typedef value_type* pointer;
     typedef value_type& reference;
 
     bool operator==(const iterator &i) const {return index == i.index;}
     bool operator!=(const iterator &i) const {return index != i.index;}
     iterator &operator++() {index = fk->get_next(index); return *this;}
     iterator operator++(int) {auto copy = *this; index = fk->get_next(index); return copy;}
     iterator &operator--() {index = fk->get_previous(index); return *this;}
     iterator operator--(int) {auto copy = *this; index = fk->get_previous(index); return copy;}
     id_of_buffer operator*() const {return id_of_buffer(Record_Id(index - 1));}
   };
 
   iterator begin() const {return ++iterator(db.storage_of_buffer);}
   iterator end() const {return iterator(db.storage_of_buffer);}
   bool is_empty() const {return db.storage_of_buffer.freedom_keeper.is_empty();}
   size_t get_size() const {return db.storage_of_buffer.freedom_keeper.get_used_count();}
   static id_of_buffer get_at(size_t i) {return id_of_buffer(Record_Id(i));}
   bool is_valid_at(size_t i) {return db.storage_of_buffer.freedom_keeper.is_used(i + 1);}
   id_of_buffer first() const {return *begin();}
   id_of_buffer last() const {return *--end();}
   id_of_buffer get_end() const {return *end();}
 };
 
 inline container_of_buffer Database::get_buffer_table() const
 {
  return container_of_buffer(*this);
 }
 
 template<class Comparator>
 std::vector<id_of_buffer> Database::sorted_buffer(Comparator comparator) const
 {
  std::vector<id_of_buffer> result;
  for (auto x: get_buffer_table())
   result.emplace_back(x);
  std::sort(result.begin(), result.end(), comparator);
  return result;
 }
}
 
#endif