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

Load a database from a read-only file. More...

#include <settings/Readonly_Database.h>

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

Public Member Functions

 Readonly_Database (joedb::Readonly_Journal &journal)
 
 Readonly_Database (joedb::Readonly_Journal &&journal)
 
 Readonly_Database (joedb::Buffered_File &file)
 
 Readonly_Database (joedb::Buffered_File &&file)
 
 Readonly_Database (const char *file_name)
 
 Readonly_Database (const std::string &file_name)
 
- Public Member Functions inherited from settings::Database
void set_max_record_id (size_t record_id)
 
bool is_valid (id_of_settings id) const
 
 Database ()
 
int64_t get_schema_checkpoint () const
 
void initialize_with_readonly_journal (joedb::Readonly_Journal &journal)
 
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{1}) const
 
const std::string & get_host (id_of_settings record=id_of_settings{1}) const
 
const std::string & get_user (id_of_settings record=id_of_settings{1}) const
 
- Public Member Functions inherited from joedb::Writable
 Writable (Commit_Level default_commit_level=Commit_Level::no_commit)
 
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 checkpoint (Commit_Level commit_level)
 
Commit_Level get_default_commit_level () const
 
void default_checkpoint ()
 
virtual void insert_into (Table_Id table_id, Record_Id record_id)
 
virtual void insert_vector (Table_Id table_id, Record_Id record_id, size_t size)
 
virtual void delete_from (Table_Id table_id, Record_Id record_id)
 
virtual void on_blob (Blob blob)
 
virtual bool wants_blob_data () const
 
virtual Blob write_blob_data (const std::string &data)
 
virtual ~Writable ()=default
 

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 ()
 
- Public Attributes inherited from settings::Database
size_t max_record_id
 
Table_Id current_table_id = Table_Id{0}
 
- 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)
 
void delete_from (Table_Id table_id, Record_Id record_id) final
 
void insert_into (Table_Id table_id, Record_Id record_id) final
 
void insert_vector (Table_Id table_id, Record_Id record_id, size_t size) final
 
void update_string (Table_Id table_id, Record_Id record_id, Field_Id field_id, const std::string &value) final
 
void update_boolean (Table_Id table_id, Record_Id record_id, Field_Id field_id, bool value) final
 
void update_vector_string (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const std::string *value) final
 
void update_vector_boolean (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const char *value) final
 
std::string * get_own_string_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) final
 
char * get_own_boolean_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) final
 
void comment (const std::string &comment) override
 
void timestamp (int64_t timestamp) override
 
void valid_data () final
 
bool requires_schema_upgrade () const
 
void check_schema ()
 
void create_table (const std::string &name) override
 
void drop_table (Table_Id table_id) final
 
void rename_table (Table_Id table_id, const std::string &name) final
 
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) final
 
void rename_field (Table_Id table_id, Field_Id field_id, const std::string &name) final
 
void custom (const std::string &name) override
 
- Protected Attributes inherited from settings::Database
detail::data_of_settings storage_of_settings
 
bool upgrading_schema = false
 
joedb::Memory_File schema_file
 
joedb::Writable_Journal schema_journal
 

Detailed Description

Definition at line 21 of file Readonly_Database.h.

Constructor & Destructor Documentation

◆ Readonly_Database() [1/6]

settings::Readonly_Database::Readonly_Database ( joedb::Readonly_Journal &  journal)
inline

Definition at line 24 of file Readonly_Database.h.

◆ Readonly_Database() [2/6]

settings::Readonly_Database::Readonly_Database ( joedb::Readonly_Journal &&  journal)
inline

Definition at line 29 of file Readonly_Database.h.

◆ Readonly_Database() [3/6]

settings::Readonly_Database::Readonly_Database ( joedb::Buffered_File &  file)
inline

Definition at line 34 of file Readonly_Database.h.

◆ Readonly_Database() [4/6]

settings::Readonly_Database::Readonly_Database ( joedb::Buffered_File &&  file)
inline

Definition at line 39 of file Readonly_Database.h.

◆ Readonly_Database() [5/6]

settings::Readonly_Database::Readonly_Database ( const char *  file_name)
inline

Definition at line 44 of file Readonly_Database.h.

◆ Readonly_Database() [6/6]

settings::Readonly_Database::Readonly_Database ( const std::string &  file_name)
inline

Definition at line 52 of file Readonly_Database.h.

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