Shortcut to directly build a Writable_Database with a Memory_File. More...

#include <tutorial/Memory_Database.h>

Inheritance diagram for tutorial::Memory_Database:

[legend]

Collaboration diagram for tutorial::Memory_Database:

[legend]

Public Member Functions
	Memory_Database ()

void	pull ()

Public Member Functions inherited from joedb::Memory_File
	Memory_File (Open_Mode mode=Open_Mode::create_new)

void	resize (size_t size)

std::string &	get_data ()

const std::string &	get_data () const

std::string	move_data () const

int64_t	get_size () const override
	Get the size of the file, or -1 if it is unknown.

size_t	pread (char *buffer, size_t size, int64_t offset) const override
	Read a range of bytes.

void	pwrite (const char *buffer, size_t size, int64_t offset) override
	Write a range of bytes. Extend file size if necessary.

Public Member Functions inherited from joedb::Abstract_File
	Abstract_File (Open_Mode mode)

bool	is_shared () const noexcept

bool	is_readonly () const noexcept

Open_Mode	get_mode () const noexcept

virtual void	sync ()
	Write data durably (including file-size change)

virtual void	datasync ()
	Write data durably (no file-size change)

virtual void	shared_lock (int64_t start, int64_t size)
	Lock a range of bytes for reading (prevents writes, not reads)

virtual void	exclusive_lock (int64_t start, int64_t size)
	Lock a range of bytes for writing (prevents both writes and reads)

virtual void	unlock (int64_t start, int64_t size) noexcept
	Remove a lock. The range should match the range of a corresponding lock.

void	exclusive_lock_tail ()

void	unlock_tail () noexcept

bool	tail_is_locked () const noexcept

void	shared_lock_head ()

void	exclusive_lock_head ()

void	unlock_head () noexcept

std::string	read_blob (Blob blob) const

virtual void	copy_to (Abstract_File &destination, int64_t start, int64_t size) const

virtual bool	equal_to (const Abstract_File &destination, int64_t from, int64_t until) const

void	copy_to (Abstract_File &destination) const

virtual	~Abstract_File ()=default

Public Member Functions inherited from tutorial::Writable_Database
	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 (const std::string &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	clear_city_table ()

id_of_city	new_city ()

id_of_city	new_vector_of_city (size_t size)

id_of_city	new_city (const std::string &field_value_of_name)

void	delete_city (id_of_city record)

void	delete_vector_of_city (id_of_city v, size_t size)

void	set_name (id_of_city record, const std::string &field_value_of_name)

template<typename F >
void	update_vector_of_name (id_of_city record, size_t size, F f)

void	clear_person_table ()

id_of_person	new_person ()

id_of_person	new_vector_of_person (size_t size)

id_of_person	new_person (const std::string &field_value_of_first_name, const std::string &field_value_of_last_name, id_of_city field_value_of_home)

void	delete_person (id_of_person record)

void	delete_vector_of_person (id_of_person v, size_t size)

void	set_first_name (id_of_person record, const std::string &field_value_of_first_name)

template<typename F >
void	update_vector_of_first_name (id_of_person record, size_t size, F f)

void	set_last_name (id_of_person record, const std::string &field_value_of_last_name)

template<typename F >
void	update_vector_of_last_name (id_of_person record, size_t size, F f)

void	set_home (id_of_person record, id_of_city field_value_of_home)

template<typename F >
void	update_vector_of_home (id_of_person record, size_t size, F f)

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	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	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	~Writable ()=default

Additional Inherited Members
Static Public Member Functions inherited from joedb::Abstract_File
static void	reading_past_end_of_file ()

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 joedb::Abstract_File
void	make_readonly ()

void	make_writable ()

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 joedb::Memory_File
std::string	data

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

Static Protected Attributes inherited from joedb::Abstract_File
static constexpr int64_t	last_position = (1ULL << 63) - 1

Detailed Description

Definition at line 21 of file Memory_Database.h.

Constructor & Destructor Documentation

◆ Memory_Database()

tutorial::Memory_Database::Memory_Database ( )

inline

Definition at line 24 of file Memory_Database.h.

Member Function Documentation

◆ pull()

void tutorial::Memory_Database::pull ( )

inline

Definition at line 28 of file Memory_Database.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Memory_Database()

Member Function Documentation

◆ pull()