A Database that contains a joedb::Writable_Journal and keeps them in sync. More...

#include <settings/Writable_Database.h>

Inheritance diagram for settings::Writable_Database:

[legend]

Collaboration diagram for settings::Writable_Database:

[legend]

Public Member Functions
	Writable_Database (joedb::Abstract_File &file)
	Writable_Database (joedb::Abstract_File &file, joedb::Recovery recovery)
const joedb::Readonly_Journal &	get_journal () const
std::string	read_blob (joedb::Blob blob) const
joedb::Blob	write_blob (std::string_view data) override
int64_t	ahead_of_checkpoint () const
void	soft_checkpoint () override
void	hard_checkpoint () override
void	write_comment (const std::string &comment)
void	write_timestamp ()
void	write_timestamp (int64_t timestamp)
void	write_valid_data ()
void	flush () override
void	set_dark_mode (id_of_settings record, bool field_value_of_dark_mode)
void	set_dark_mode (bool field_value_of_dark_mode)
void	set_host (id_of_settings record, std::string_view field_value_of_host)
void	set_host (std::string_view field_value_of_host)
void	set_user (id_of_settings record, std::string_view field_value_of_user)
void	set_user (std::string_view field_value_of_user)
Public Member Functions inherited from settings::Database_Writable
	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
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	update_int32 (Table_Id table_id, Record_Id record_id, Field_Id field_id, int32_t value)
virtual void	update_int64 (Table_Id table_id, Record_Id record_id, Field_Id field_id, int64_t value)
virtual void	update_float32 (Table_Id table_id, Record_Id record_id, Field_Id field_id, float value)
virtual void	update_float64 (Table_Id table_id, Record_Id record_id, Field_Id field_id, double value)
virtual void	update_int8 (Table_Id table_id, Record_Id record_id, Field_Id field_id, int8_t value)
virtual void	update_int16 (Table_Id table_id, Record_Id record_id, Field_Id field_id, int16_t value)
virtual void	update_blob (Table_Id table_id, Record_Id record_id, Field_Id field_id, joedb::Blob value)
const std::string *	get_own_string_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_int32 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const int32_t *value)
virtual int32_t *	get_own_int32_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const int32_t *	get_own_int32_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_int64 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const int64_t *value)
virtual int64_t *	get_own_int64_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const int64_t *	get_own_int64_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_reference (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const joedb::Record_Id *value)
virtual joedb::Record_Id *	get_own_reference_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const joedb::Record_Id *	get_own_reference_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
const char *	get_own_boolean_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_float32 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const float *value)
virtual float *	get_own_float32_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const float *	get_own_float32_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_float64 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const double *value)
virtual double *	get_own_float64_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const double *	get_own_float64_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_int8 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const int8_t *value)
virtual int8_t *	get_own_int8_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const int8_t *	get_own_int8_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_int16 (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const int16_t *value)
virtual int16_t *	get_own_int16_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const int16_t *	get_own_int16_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	update_vector_blob (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const joedb::Blob *value)
virtual joedb::Blob *	get_own_blob_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity)
const joedb::Blob *	get_own_blob_const_storage (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t &capacity) const
virtual void	on_blob (Blob blob)
virtual bool	wants_blob_data () const
virtual	~Writable ()=default

Friends
class	Client
class	Multiplexer
class	Memory_Database

Additional Inherited Members
Static Public Member Functions inherited from settings::Database
template<typename E = joedb::Exception>
static void	throw_exception (std::string_view message)
static id_of_settings	null_settings ()
static constexpr id_of_settings	the_settings ()
Protected Member Functions inherited from settings::Database_Writable
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, std::string_view 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	drop_table (Table_Id table_id) override
void	rename_table (Table_Id table_id, const std::string &name) 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, std::string_view 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, std::string_view field_value_of_user)
void	internal_update_vector_settings__user (Record_Id record_id, size_t size, const std::string *value)
Protected Attributes inherited from settings::Database_Writable
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

Detailed Description

Definition at line 29 of file Writable_Database.h.

Constructor & Destructor Documentation

◆ Writable_Database() [1/2]

settings::Writable_Database::Writable_Database ( joedb::Abstract_File & file )

Definition at line 111 of file Writable_Database.cpp.

◆ Writable_Database() [2/2]

settings::Writable_Database::Writable_Database	(	joedb::Abstract_File &	file,
		joedb::Recovery	recovery )

Definition at line 118 of file Writable_Database.cpp.

Member Function Documentation

◆ ahead_of_checkpoint()

int64_t settings::Writable_Database::ahead_of_checkpoint ( ) const

inline

Definition at line 82 of file Writable_Database.h.

◆ flush()

void settings::Writable_Database::flush ( )

inlineoverridevirtual

Reimplemented from joedb::Writable.

Definition at line 101 of file Writable_Database.h.

◆ get_journal()

const joedb::Readonly_Journal & settings::Writable_Database::get_journal ( ) const

inline

Definition at line 70 of file Writable_Database.h.

◆ hard_checkpoint()

void settings::Writable_Database::hard_checkpoint ( )

inlineoverridevirtual

Reimplemented from joedb::Writable.

Definition at line 92 of file Writable_Database.h.

◆ read_blob()

std::string settings::Writable_Database::read_blob ( joedb::Blob blob ) const

inline

Definition at line 72 of file Writable_Database.h.

◆ set_dark_mode() [1/2]

void settings::Writable_Database::set_dark_mode ( bool field_value_of_dark_mode )

inline

Definition at line 143 of file Writable_Database.h.

◆ set_dark_mode() [2/2]

void settings::Writable_Database::set_dark_mode	(	id_of_settings	record,
		bool	field_value_of_dark_mode )

inline

Definition at line 137 of file Writable_Database.h.

◆ set_host() [1/2]

void settings::Writable_Database::set_host	(	id_of_settings	record,
		std::string_view	field_value_of_host )

inline

Definition at line 148 of file Writable_Database.h.

◆ set_host() [2/2]

void settings::Writable_Database::set_host ( std::string_view field_value_of_host )

inline

Definition at line 154 of file Writable_Database.h.

◆ set_user() [1/2]

void settings::Writable_Database::set_user	(	id_of_settings	record,
		std::string_view	field_value_of_user )

inline

Definition at line 159 of file Writable_Database.h.

◆ set_user() [2/2]

void settings::Writable_Database::set_user ( std::string_view field_value_of_user )

inline

Definition at line 165 of file Writable_Database.h.

◆ soft_checkpoint()

void settings::Writable_Database::soft_checkpoint ( )

inlineoverridevirtual

Reimplemented from joedb::Writable.

Definition at line 87 of file Writable_Database.h.

◆ write_blob()

joedb::Blob settings::Writable_Database::write_blob ( std::string_view data )

inlineoverridevirtual

Reimplemented from joedb::Writable.

Definition at line 77 of file Writable_Database.h.

◆ write_comment()

void settings::Writable_Database::write_comment ( const std::string & comment )

Definition at line 20 of file Writable_Database.cpp.

◆ write_timestamp() [1/2]

void settings::Writable_Database::write_timestamp ( )

Definition at line 27 of file Writable_Database.cpp.

◆ write_timestamp() [2/2]

void settings::Writable_Database::write_timestamp ( int64_t timestamp )

Definition at line 34 of file Writable_Database.cpp.

◆ write_valid_data()

void settings::Writable_Database::write_valid_data ( )

Definition at line 41 of file Writable_Database.cpp.

◆ Client

friend class Client

friend

Definition at line 32 of file Writable_Database.h.

◆ Memory_Database

friend class Memory_Database

friend

Definition at line 34 of file Writable_Database.h.

◆ Multiplexer

friend class Multiplexer

friend

Definition at line 33 of file Writable_Database.h.

The documentation for this class was generated from the following files:

/home/rcoulom/repos/joedb/doc/source/tutorial/src/settings/Writable_Database.h
/home/rcoulom/repos/joedb/doc/source/tutorial/src/settings/Writable_Database.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Writable_Database() [1/2]

◆ Writable_Database() [2/2]

Member Function Documentation

◆ ahead_of_checkpoint()

◆ flush()

◆ get_journal()

◆ hard_checkpoint()

◆ read_blob()

◆ set_dark_mode() [1/2]

◆ set_dark_mode() [2/2]

◆ set_host() [1/2]

◆ set_host() [2/2]

◆ set_user() [1/2]

◆ set_user() [2/2]

◆ soft_checkpoint()

◆ write_blob()

◆ write_comment()

◆ write_timestamp() [1/2]

◆ write_timestamp() [2/2]

◆ write_valid_data()

Friends And Related Symbol Documentation

◆ Client

◆ Memory_Database

◆ Multiplexer