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

#include <tutorial/Readonly_Database.h>

Inheritance diagram for tutorial::Readonly_Database:

[legend]

Collaboration diagram for tutorial::Readonly_Database:

[legend]

Public Member Functions
	Readonly_Database (joedb::Readonly_Journal &journal)

	Readonly_Database (joedb::Readonly_Journal &&journal)

	Readonly_Database (joedb::Abstract_File &file)

	Readonly_Database (joedb::Abstract_File &&file)

	Readonly_Database (const char *file_name)

	Readonly_Database (const std::string &file_name)

Public Member Functions inherited from tutorial::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 tutorial::Database
bool	is_valid (id_of_city id) const

bool	is_valid (id_of_person id) const

container_of_city	get_city_table () const

id_of_city	next (id_of_city id) const

id_of_city	previous (id_of_city id) const

template<class Comparator >
std::vector< id_of_city >	sorted_city (Comparator comparator) const

const std::string &	get_name (id_of_city record) const

container_of_person	get_person_table () const

id_of_person	next (id_of_person id) const

id_of_person	previous (id_of_person id) const

template<class Comparator >
std::vector< id_of_person >	sorted_person (Comparator comparator) const

const std::string &	get_first_name (id_of_person record) const

const std::string &	get_last_name (id_of_person record) const

id_of_city	get_home (id_of_person record) const

const std::map< std::string, id_of_city > &	get_index_of_city_by_name ()

const std::multimap< std::tuple< std::string, std::string >, id_of_person > &	get_index_of_person_by_name ()

id_of_city	next_city_by_name (id_of_city id)

id_of_city	previous_city_by_name (id_of_city id)

id_of_city	find_city_by_name (const std::string &field_value_of_name) const

range_of_person_by_name	find_person_by_name (const std::string &field_value_of_last_name, const std::string &field_value_of_first_name) 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

Additional Inherited Members
Static Public Member Functions inherited from tutorial::Database
template<typename E = joedb::Exception>
static void	throw_exception (const std::string &message)

static id_of_city	null_city ()

static id_of_person	null_person ()

Protected Member Functions inherited from tutorial::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, const std::string &value) override

void	update_reference (Table_Id table_id, Record_Id record_id, Field_Id field_id, joedb::Record_Id 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_reference (Table_Id table_id, Record_Id record_id, Field_Id field_id, size_t size, const joedb::Record_Id *value) override

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

joedb::Record_Id *	get_own_reference_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 tutorial::Database
bool	is_valid_record_id_for_city (Record_Id record_id) const

bool	is_valid_record_id_for_person (Record_Id record_id) const

void	remove_index_of_city_by_name (Record_Id record_id)

void	add_index_of_city_by_name (Record_Id record_id)

void	remove_index_of_person_by_name (Record_Id record_id)

void	add_index_of_person_by_name (Record_Id record_id)

void	internal_delete_city (Record_Id record_id)

void	internal_delete_person (Record_Id record_id)

void	internal_insert_city (Record_Id record_id)

void	internal_vector_insert_city (Record_Id record_id, size_t size)

void	internal_insert_person (Record_Id record_id)

void	internal_vector_insert_person (Record_Id record_id, size_t size)

void	internal_update_city__name (Record_Id record_id, const std::string &field_value_of_name)

void	internal_update_vector_city__name (Record_Id record_id, size_t size, const std::string *value)

void	internal_update_person__first_name (Record_Id record_id, const std::string &field_value_of_first_name)

void	internal_update_vector_person__first_name (Record_Id record_id, size_t size, const std::string *value)

void	internal_update_person__last_name (Record_Id record_id, const std::string &field_value_of_last_name)

void	internal_update_vector_person__last_name (Record_Id record_id, size_t size, const std::string *value)

void	internal_update_person__home (Record_Id record_id, id_of_city field_value_of_home)

void	internal_update_vector_person__home (Record_Id record_id, size_t size, const id_of_city *value)

Protected Attributes inherited from tutorial::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 tutorial::Database
detail::data_of_city	storage_of_city

detail::data_of_person	storage_of_person

std::map< std::string, id_of_city >	index_of_city_by_name

std::multimap< std::tuple< std::string, std::string >, id_of_person >	index_of_person_by_name

Detailed Description

Definition at line 21 of file Readonly_Database.h.

Constructor & Destructor Documentation

◆ Readonly_Database() [1/6]

tutorial::Readonly_Database::Readonly_Database ( joedb::Readonly_Journal & journal )

inline

Definition at line 24 of file Readonly_Database.h.

◆ Readonly_Database() [2/6]

tutorial::Readonly_Database::Readonly_Database ( joedb::Readonly_Journal && journal )

inline

Definition at line 29 of file Readonly_Database.h.

◆ Readonly_Database() [3/6]

tutorial::Readonly_Database::Readonly_Database ( joedb::Abstract_File & file )

inline

Definition at line 34 of file Readonly_Database.h.

◆ Readonly_Database() [4/6]

tutorial::Readonly_Database::Readonly_Database ( joedb::Abstract_File && file )

inline

Definition at line 39 of file Readonly_Database.h.

◆ Readonly_Database() [5/6]

tutorial::Readonly_Database::Readonly_Database ( const char * file_name )

inline

Definition at line 44 of file Readonly_Database.h.

◆ Readonly_Database() [6/6]

tutorial::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:

/home/rcoulom/repos/joedb/doc/source/tutorial/src/tutorial/Readonly_Database.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Readonly_Database() [1/6]

◆ Readonly_Database() [2/6]

◆ Readonly_Database() [3/6]

◆ Readonly_Database() [4/6]

◆ Readonly_Database() [5/6]

◆ Readonly_Database() [6/6]