Joedb 10.0.0
The Journal-Only Embedded Database
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
settings::Database_Writable Class Reference

implement joedb::Writable in a Database More...

#include <settings/Database_Writable.h>

Inheritance diagram for settings::Database_Writable:
Inheritance graph
[legend]
Collaboration diagram for settings::Database_Writable:
Collaboration graph
[legend]

Public Member Functions

 Database_Writable ()
 
void set_max_record_id (joedb::index_t record_id)
 
int64_t get_schema_checkpoint () const
 
void initialize_with_readonly_journal (joedb::Readonly_Journal &journal)
 
- Public Member Functions inherited from settings::Database
bool is_valid (id_of_settings id) const
 
container_of_settings get_settings_table () const
 
id_of_settings next (id_of_settings id) const
 
id_of_settings previous (id_of_settings id) const
 
template<class Comparator >
std::vector< id_of_settings > sorted_settings (Comparator comparator) const
 
bool get_dark_mode (id_of_settings record=id_of_settings{0}) const
 
const std::string & get_host (id_of_settings record=id_of_settings{0}) const
 
const std::string & get_user (id_of_settings record=id_of_settings{0}) const
 
- Public Member Functions inherited from joedb::Writable
virtual int64_t get_position () const
 
virtual void start_writing (int64_t position)
 
virtual void end_writing (int64_t position)
 
virtual void soft_checkpoint ()
 
virtual void hard_checkpoint ()
 
virtual void drop_table (Table_Id table_id)
 
virtual void rename_table (Table_Id table_id, const std::string &name)
 
virtual void add_field (Table_Id table_id, const std::string &name, Type type)
 
virtual void drop_field (Table_Id table_id, Field_Id field_id)
 
virtual void rename_field (Table_Id table_id, Field_Id field_id, const std::string &name)
 
virtual void flush ()
 
virtual void insert_into (Table_Id table_id, Record_Id record_id)
 
virtual void delete_from (Table_Id table_id, Record_Id record_id)
 
virtual void insert_vector (Table_Id table_id, Record_Id record_id, size_t size)=0
 
virtual void delete_vector (Table_Id table_id, Record_Id record_id, size_t size)=0
 
virtual void on_blob (Blob blob)
 
virtual bool wants_blob_data () const
 
virtual Blob write_blob (const std::string &data)
 
virtual ~Writable ()=default
 

Protected Member Functions

void delete_from (Table_Id table_id, Record_Id record_id) override
 
void insert_into (Table_Id table_id, Record_Id record_id) override
 
void delete_vector (Table_Id table_id, Record_Id record_id, size_t size) override
 
void insert_vector (Table_Id table_id, Record_Id record_id, size_t size) override
 
void update_string (Table_Id table_id, Record_Id record_id, Field_Id field_id, const std::string &value) override
 
void update_boolean (Table_Id table_id, Record_Id record_id, Field_Id field_id, bool value) override
 
void update_vector_string (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const std::string *value) override
 
void update_vector_boolean (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const char *value) override
 
std::string * get_own_string_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) override
 
char * get_own_boolean_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) override
 
void comment (const std::string &comment) override
 
void timestamp (int64_t timestamp) override
 
void valid_data () override
 
bool requires_schema_upgrade () const
 
void check_schema ()
 
void create_table (const std::string &name) override
 
void drop_table (Table_Id table_id) override
 
void rename_table (Table_Id table_id, const std::string &name) override
 
void add_field (Table_Id table_id, const std::string &name, joedb::Type type) override
 
void drop_field (Table_Id table_id, Field_Id field_id) override
 
void rename_field (Table_Id table_id, Field_Id field_id, const std::string &name) override
 
void custom (const std::string &name) override
 
- Protected Member Functions inherited from settings::Database
bool is_valid_record_id_for_settings (Record_Id record_id) const
 
void internal_delete_settings (Record_Id record_id)
 
void internal_insert_settings (Record_Id record_id)
 
void internal_vector_insert_settings (Record_Id record_id, size_t size)
 
void internal_update_settings__dark_mode (Record_Id record_id, bool field_value_of_dark_mode)
 
void internal_update_vector_settings__dark_mode (Record_Id record_id, size_t size, const char *value)
 
void internal_update_settings__host (Record_Id record_id, const std::string &field_value_of_host)
 
void internal_update_vector_settings__host (Record_Id record_id, size_t size, const std::string *value)
 
void internal_update_settings__user (Record_Id record_id, const std::string &field_value_of_user)
 
void internal_update_vector_settings__user (Record_Id record_id, size_t size, const std::string *value)
 

Protected Attributes

joedb::index_t max_record_id
 
Table_Id current_table_id = Table_Id{0}
 
bool upgrading_schema = false
 
joedb::Memory_File schema_file
 
joedb::Writable_Journal schema_journal
 
- Protected Attributes inherited from settings::Database
detail::data_of_settings storage_of_settings
 

Additional Inherited Members

- Static Public Member Functions inherited from settings::Database
template<typename E = joedb::Exception>
static void throw_exception (const std::string &message)
 
static id_of_settings null_settings ()
 
static constexpr id_of_settings the_settings ()
 

Detailed Description

Definition at line 36 of file Database_Writable.h.

Constructor & Destructor Documentation

◆ Database_Writable()

settings::Database_Writable::Database_Writable ( )
inline

Definition at line 334 of file Database_Writable.h.

Member Function Documentation

◆ add_field()

void settings::Database_Writable::add_field ( Table_Id  table_id,
const std::string &  name,
joedb::Type  type 
)
inlineoverrideprotected

Definition at line 299 of file Database_Writable.h.

◆ check_schema()

void settings::Database_Writable::check_schema ( )
inlineprotected

Definition at line 255 of file Database_Writable.h.

◆ comment()

void settings::Database_Writable::comment ( const std::string &  comment)
inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 242 of file Database_Writable.h.

◆ create_table()

void settings::Database_Writable::create_table ( const std::string &  name)
inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 276 of file Database_Writable.h.

◆ custom()

void settings::Database_Writable::custom ( const std::string &  name)
inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 327 of file Database_Writable.h.

◆ delete_from()

void settings::Database_Writable::delete_from ( Table_Id  table_id,
Record_Id  record_id 
)
inlineoverrideprotected

Definition at line 42 of file Database_Writable.h.

◆ delete_vector()

void settings::Database_Writable::delete_vector ( Table_Id  table_id,
Record_Id  record_id,
size_t  size 
)
inlineoverrideprotected

Definition at line 62 of file Database_Writable.h.

◆ drop_field()

void settings::Database_Writable::drop_field ( Table_Id  table_id,
Field_Id  field_id 
)
inlineoverrideprotected

Definition at line 310 of file Database_Writable.h.

◆ drop_table()

void settings::Database_Writable::drop_table ( Table_Id  table_id)
inlineoverrideprotected

Definition at line 283 of file Database_Writable.h.

◆ get_own_boolean_storage()

char * settings::Database_Writable::get_own_boolean_storage ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
size_t &  capacity 
)
inlineoverrideprotected

Definition at line 221 of file Database_Writable.h.

◆ get_own_string_storage()

std::string * settings::Database_Writable::get_own_string_storage ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
size_t &  capacity 
)
inlineoverrideprotected

Definition at line 196 of file Database_Writable.h.

◆ get_schema_checkpoint()

int64_t settings::Database_Writable::get_schema_checkpoint ( ) const
inline

Definition at line 344 of file Database_Writable.h.

◆ initialize_with_readonly_journal()

void settings::Database_Writable::initialize_with_readonly_journal ( joedb::Readonly_Journal &  journal)
inline

Definition at line 349 of file Database_Writable.h.

◆ insert_into()

void settings::Database_Writable::insert_into ( Table_Id  table_id,
Record_Id  record_id 
)
inlineoverrideprotected

Definition at line 48 of file Database_Writable.h.

◆ insert_vector()

void settings::Database_Writable::insert_vector ( Table_Id  table_id,
Record_Id  record_id,
size_t  size 
)
inlineoverrideprotected

Definition at line 81 of file Database_Writable.h.

◆ rename_field()

void settings::Database_Writable::rename_field ( Table_Id  table_id,
Field_Id  field_id,
const std::string &  name 
)
inlineoverrideprotected

Definition at line 316 of file Database_Writable.h.

◆ rename_table()

void settings::Database_Writable::rename_table ( Table_Id  table_id,
const std::string &  name 
)
inlineoverrideprotected

Definition at line 289 of file Database_Writable.h.

◆ requires_schema_upgrade()

bool settings::Database_Writable::requires_schema_upgrade ( ) const
inlineprotected

Definition at line 250 of file Database_Writable.h.

◆ set_max_record_id()

void settings::Database_Writable::set_max_record_id ( joedb::index_t  record_id)
inline

Definition at line 339 of file Database_Writable.h.

◆ timestamp()

void settings::Database_Writable::timestamp ( int64_t  timestamp)
inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 243 of file Database_Writable.h.

◆ update_boolean()

void settings::Database_Writable::update_boolean ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
bool  value 
)
inlineoverrideprotected

Definition at line 129 of file Database_Writable.h.

◆ update_string()

void settings::Database_Writable::update_string ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
const std::string &  value 
)
inlineoverrideprotected

Definition at line 104 of file Database_Writable.h.

◆ update_vector_boolean()

void settings::Database_Writable::update_vector_boolean ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
size_t  size,
const char *  value 
)
inlineoverrideprotected

Definition at line 175 of file Database_Writable.h.

◆ update_vector_string()

void settings::Database_Writable::update_vector_string ( Table_Id  table_id,
Record_Id  record_id,
Field_Id  field_id,
size_t  size,
const std::string *  value 
)
inlineoverrideprotected

Definition at line 149 of file Database_Writable.h.

◆ valid_data()

void settings::Database_Writable::valid_data ( )
inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 244 of file Database_Writable.h.

Member Data Documentation

◆ current_table_id

Table_Id settings::Database_Writable::current_table_id = Table_Id{0}
protected

Definition at line 40 of file Database_Writable.h.

◆ max_record_id

joedb::index_t settings::Database_Writable::max_record_id
protected

Definition at line 39 of file Database_Writable.h.

◆ schema_file

joedb::Memory_File settings::Database_Writable::schema_file
protected

Definition at line 247 of file Database_Writable.h.

◆ schema_journal

joedb::Writable_Journal settings::Database_Writable::schema_journal
protected

Definition at line 248 of file Database_Writable.h.

◆ upgrading_schema

bool settings::Database_Writable::upgrading_schema = false
protected

Definition at line 246 of file Database_Writable.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8