Store all the tables of the database. More...

#include <settings/Database.h>

Inheritance diagram for settings::Database:

[legend]

Collaboration diagram for settings::Database:

[legend]

Public Member Functions
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

Static Public Member Functions
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
size_t	max_record_id

Table_Id	current_table_id = Table_Id{0}

Protected Member Functions
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
detail::data_of_settings	storage_of_settings

bool	upgrading_schema = false

joedb::Memory_File	schema_file

joedb::Writable_Journal	schema_journal

Friends
class	Readable

class	id_of_settings

class	container_of_settings

Detailed Description

Definition at line 75 of file Database.h.

Constructor & Destructor Documentation

◆ Database()

settings::Database::Database ( )

inline

Definition at line 468 of file Database.h.

Member Function Documentation

◆ add_field()

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

inlineoverrideprotected

Definition at line 433 of file Database.h.

◆ check_schema()

void settings::Database::check_schema ( )

inlineprotected

Definition at line 389 of file Database.h.

◆ comment()

void settings::Database::comment ( const std::string & comment )

inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 376 of file Database.h.

◆ create_table()

void settings::Database::create_table ( const std::string & name )

inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 410 of file Database.h.

◆ custom()

void settings::Database::custom ( const std::string & name )

inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 461 of file Database.h.

◆ delete_from()

void settings::Database::delete_from	(	Table_Id	table_id,
		Record_Id	record_id
	)

inlinefinalprotected

Definition at line 194 of file Database.h.

◆ drop_field()

void settings::Database::drop_field	(	Table_Id	table_id,
		Field_Id	field_id
	)

inlinefinalprotected

Definition at line 444 of file Database.h.

◆ drop_table()

void settings::Database::drop_table ( Table_Id table_id )

inlinefinalprotected

Definition at line 417 of file Database.h.

◆ get_dark_mode()

bool settings::Database::get_dark_mode ( id_of_settings record = id_of_settings{1} ) const

inline

Definition at line 520 of file Database.h.

◆ get_host()

const std::string & settings::Database::get_host ( id_of_settings record = id_of_settings{1} ) const

inline

Definition at line 526 of file Database.h.

◆ get_own_boolean_storage()

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

inlinefinalprotected

Definition at line 355 of file Database.h.

◆ get_own_string_storage()

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

inlinefinalprotected

Definition at line 330 of file Database.h.

◆ get_schema_checkpoint()

int64_t settings::Database::get_schema_checkpoint ( ) const

inline

Definition at line 473 of file Database.h.

◆ get_settings_table()

container_of_settings settings::Database::get_settings_table ( ) const

inline

Definition at line 582 of file Database.h.

◆ get_user()

const std::string & settings::Database::get_user ( id_of_settings record = id_of_settings{1} ) const

inline

Definition at line 532 of file Database.h.

◆ initialize_with_readonly_journal()

void settings::Database::initialize_with_readonly_journal ( joedb::Readonly_Journal & journal )

inline

Definition at line 478 of file Database.h.

◆ insert_into()

void settings::Database::insert_into	(	Table_Id	table_id,
		Record_Id	record_id
	)

inlinefinalprotected

Definition at line 200 of file Database.h.

◆ insert_vector()

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

inlinefinalprotected

Definition at line 215 of file Database.h.

◆ internal_delete_settings()

void settings::Database::internal_delete_settings ( Record_Id record_id )

inlineprotected

Definition at line 102 of file Database.h.

◆ internal_insert_settings()

void settings::Database::internal_insert_settings ( Record_Id record_id )

inlineprotected

Definition at line 111 of file Database.h.

◆ internal_update_settings__dark_mode()

void settings::Database::internal_update_settings__dark_mode	(	Record_Id	record_id,
		bool	field_value_of_dark_mode
	)

inlineprotected

Definition at line 121 of file Database.h.

◆ internal_update_settings__host()

void settings::Database::internal_update_settings__host	(	Record_Id	record_id,
		const std::string &	field_value_of_host
	)

inlineprotected

Definition at line 145 of file Database.h.

◆ internal_update_settings__user()

void settings::Database::internal_update_settings__user	(	Record_Id	record_id,
		const std::string &	field_value_of_user
	)

inlineprotected

Definition at line 169 of file Database.h.

◆ internal_update_vector_settings__dark_mode()

void settings::Database::internal_update_vector_settings__dark_mode	(	Record_Id	record_id,
		size_t	size,
		const char *	value
	)

inlineprotected

Definition at line 131 of file Database.h.

◆ internal_update_vector_settings__host()

void settings::Database::internal_update_vector_settings__host	(	Record_Id	record_id,
		size_t	size,
		const std::string *	value
	)

inlineprotected

Definition at line 155 of file Database.h.

◆ internal_update_vector_settings__user()

void settings::Database::internal_update_vector_settings__user	(	Record_Id	record_id,
		size_t	size,
		const std::string *	value
	)

inlineprotected

Definition at line 179 of file Database.h.

◆ internal_vector_insert_settings()

void settings::Database::internal_vector_insert_settings	(	Record_Id	record_id,
		size_t	size
	)

inlineprotected

Definition at line 116 of file Database.h.

◆ is_valid()

bool settings::Database::is_valid ( id_of_settings id ) const

inline

Definition at line 96 of file Database.h.

◆ is_valid_record_id_for_settings()

bool settings::Database::is_valid_record_id_for_settings ( Record_Id record_id ) const

inlineprotected

Definition at line 100 of file Database.h.

◆ next()

id_of_settings settings::Database::next ( id_of_settings id ) const

inline

Definition at line 492 of file Database.h.

◆ null_settings()

static id_of_settings settings::Database::null_settings ( )

inlinestatic

Definition at line 511 of file Database.h.

◆ previous()

id_of_settings settings::Database::previous ( id_of_settings id ) const

inline

Definition at line 500 of file Database.h.

◆ rename_field()

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

inlinefinalprotected

Definition at line 450 of file Database.h.

◆ rename_table()

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

inlinefinalprotected

Definition at line 423 of file Database.h.

◆ requires_schema_upgrade()

bool settings::Database::requires_schema_upgrade ( ) const

inlineprotected

Definition at line 384 of file Database.h.

◆ set_max_record_id()

void settings::Database::set_max_record_id ( size_t record_id )

inline

Definition at line 91 of file Database.h.

◆ sorted_settings()

template<class Comparator >

std::vector< id_of_settings > settings::Database::sorted_settings ( Comparator comparator ) const

Definition at line 588 of file Database.h.

◆ the_settings()

static constexpr id_of_settings settings::Database::the_settings ( )

inlinestaticconstexpr

Definition at line 515 of file Database.h.

◆ throw_exception()

template<typename E = joedb::Exception>

static void settings::Database::throw_exception ( const std::string & message )

inlinestatic

Definition at line 83 of file Database.h.

◆ timestamp()

void settings::Database::timestamp ( int64_t timestamp )

inlineoverrideprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 377 of file Database.h.

◆ update_boolean()

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

inlinefinalprotected

Definition at line 263 of file Database.h.

◆ update_string()

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

inlinefinalprotected

Definition at line 238 of file Database.h.

◆ update_vector_boolean()

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

inlinefinalprotected

Definition at line 309 of file Database.h.

◆ update_vector_string()

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

inlinefinalprotected

Definition at line 283 of file Database.h.

◆ valid_data()

void settings::Database::valid_data ( )

inlinefinalprotectedvirtual

Reimplemented from joedb::Writable.

Definition at line 378 of file Database.h.

Friends And Related Symbol Documentation

◆ container_of_settings

friend class container_of_settings

friend

Definition at line 79 of file Database.h.

◆ id_of_settings

friend class id_of_settings

friend

Definition at line 78 of file Database.h.

◆ Readable

friend class Readable

friend

Definition at line 77 of file Database.h.

Member Data Documentation

◆ current_table_id

Table_Id settings::Database::current_table_id = Table_Id{0}

Definition at line 89 of file Database.h.

◆ max_record_id

size_t settings::Database::max_record_id

Definition at line 88 of file Database.h.

◆ schema_file

joedb::Memory_File settings::Database::schema_file

protected

Definition at line 381 of file Database.h.

◆ schema_journal

joedb::Writable_Journal settings::Database::schema_journal

protected

Definition at line 382 of file Database.h.

◆ storage_of_settings

detail::data_of_settings settings::Database::storage_of_settings

protected

Definition at line 99 of file Database.h.

◆ upgrading_schema

bool settings::Database::upgrading_schema = false

protected

Definition at line 380 of file Database.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Database()

Member Function Documentation

◆ add_field()

◆ check_schema()

◆ comment()

◆ create_table()

◆ custom()

◆ delete_from()

◆ drop_field()

◆ drop_table()

◆ get_dark_mode()

◆ get_host()

◆ get_own_boolean_storage()

◆ get_own_string_storage()

◆ get_schema_checkpoint()

◆ get_settings_table()

◆ get_user()

◆ initialize_with_readonly_journal()

◆ insert_into()

◆ insert_vector()

◆ internal_delete_settings()

◆ internal_insert_settings()

◆ internal_update_settings__dark_mode()

◆ internal_update_settings__host()

◆ internal_update_settings__user()

◆ internal_update_vector_settings__dark_mode()

◆ internal_update_vector_settings__host()

◆ internal_update_vector_settings__user()

◆ internal_vector_insert_settings()

◆ is_valid()

◆ is_valid_record_id_for_settings()

◆ next()

◆ null_settings()

◆ previous()

◆ rename_field()

◆ rename_table()

◆ requires_schema_upgrade()

◆ set_max_record_id()

◆ sorted_settings()

◆ the_settings()

◆ throw_exception()

◆ timestamp()

◆ update_boolean()

◆ update_string()

◆ update_vector_boolean()

◆ update_vector_string()

◆ valid_data()

Friends And Related Symbol Documentation

◆ container_of_settings

◆ id_of_settings

◆ Readable

Member Data Documentation

◆ current_table_id

◆ max_record_id

◆ schema_file

◆ schema_journal

◆ storage_of_settings

◆ upgrading_schema