Класс localhost_t

#include <localhost.hpp>

Граф наследования:localhost_t:

Полный список членов класса

---

Подробное описание

Интерфейс объекта, управляющего базами данных на локальной машине.

Фактически, часть сервера баз данных, отвечающая только за взаимодействие базой данных.

Открытые типы
	no_overwrite = 1
	Не пересоздавать уже существующую БД.
enum	{ no_overwrite = 1 }
	Параметры создания БД. Подробнее...
Открытые члены
virtual void	db_create (const std::string &physic_name, oess_1::uint_t creation_mode)=0
	Физически создать базу данных.
virtual void	db_create (const std::string &physic_name, const oess_1::db::storage::config_t &config, oess_1::uint_t creation_mode)=0
	Физически создать базу данных.
virtual void	db_describe (const std::string &logic_name, const std::string &physic_name, oess_1::uint_t cache_size, bool is_read_only, bool is_auto_repair_enabled)=0
	Описать доступную для использования базу.
virtual void	db_describe (const std::string &logic_name, const std::string &physic_name, const oess_1::db::storage::config_t &config, bool is_read_only, bool is_auto_repair_enabled)=0
	Описать доступную для использования базу.
virtual void	db_flush_all ()=0
	Сбросить содержимое кэша открытых БД на диск.
virtual bool	db_set_auto_flush (const std::string &logic_name, bool is_on)=0
	изменяющей указанную БД.
virtual impl::response_t *	process (const impl::request_t &req)=0
	Обработать запрос и отдать результат.

---

Перечисления

anonymous enum

Параметры создания БД.

Элементы перечислений:

no_overwrite

Не пересоздавать уже существующую БД.

---

Методы

virtual void db_create	(	const std::string &	physic_name,
		const oess_1::db::storage::config_t &	config,
		oess_1::uint_t	creation_mode
	)			[pure virtual]

Физически создать базу данных.

Начиная с:

v.1.4.0

Использование этого метода предпочтительнее, т.к. он предоставляет возможность задать конфигурацию новой БД.

Созданная база данных не становится автоматически доступной для использования. После успешного создания база должна быть описана последующим обращением к db_describe().

Аргументы:

physic_name	Физическое имя БД (имя файла без расширения).
config	Конфигурация новой БД.
creation_mode	Битовая маска флагов, определяющих режим создания БД. Если установлен флаг no_overwrite, то существующая БД не пересоздается. В противном случае старое содержимое БД будет потеряно.

Замещается в std_localhost_t.

virtual void db_create	(	const std::string &	physic_name,
		oess_1::uint_t	creation_mode
	)			[pure virtual]

Физически создать базу данных.

Начиная с:

v.1.1.0

Создается база с пустой схемой данных.

Созданная база данных не становится автоматически доступной для использования. После успешного создания база должна быть описана последующим обращением к db_describe().

Аргументы:

physic_name	Физическое имя БД (имя файла без расширения).
creation_mode	Битовая маска флагов, определяющих режим создания БД. Если установлен флаг no_overwrite, то существующая БД не пересоздается. В противном случае старое содержимое БД будет потеряно.

Замещается в std_localhost_t.

virtual void db_describe	(	const std::string &	logic_name,
		const std::string &	physic_name,
		const oess_1::db::storage::config_t &	config,
		bool	is_read_only,
		bool	is_auto_repair_enabled
	)			[pure virtual]

Описать доступную для использования базу.

Начиная с:

v.1.4.0

Использование этого метода предпочтительнее, т.к. он предоставляет возможность задать конфигурацию новой БД.

Аргументы:

logic_name	Логическое имя БД (т.е. имя, через которое база будет доступна клиентам).
physic_name	Физическое имя БД (фактически, имя файла БД без расширения).
config	Конфигурация для использования БД.
is_read_only	true, если БД нужно открыть в режиме read-only.
is_auto_repair_enabled	true, если разрешается автоматическое восстановление БД после сбоев.

Замещается в std_localhost_t.

virtual void db_describe	(	const std::string &	logic_name,
		const std::string &	physic_name,
		oess_1::uint_t	cache_size,
		bool	is_read_only,
		bool	is_auto_repair_enabled
	)			[pure virtual]

Описать доступную для использования базу.

Аргументы:

logic_name	Логическое имя БД (т.е. имя, через которое база будет доступна клиентам).
physic_name	Физическое имя БД (фактически, имя файла БД без расширения).
cache_size	Размер кэша для этой базы (количество страниц хранилища, одновременно удерживаемых в ОП). Уст.: Начиная с версии v.1.4. игнорируется.
is_read_only	true, если БД нужно открыть в режиме read-only.
is_auto_repair_enabled	true, если разрешается автоматическое восстановление БД после сбоев.

Замещается в std_localhost_t.

virtual void db_flush_all

(

)

[pure virtual]

Сбросить содержимое кэша открытых БД на диск.

Уст.:

Начиная с версии v.1.4. флуширование БД осуществляется автоматически при завершении транзакции.

Замещается в std_localhost_t.

virtual bool db_set_auto_flush	(	const std::string &	logic_name,
		bool	is_on
	)			[pure virtual]

изменяющей указанную БД.

Уст.:

Начиная с версии v.1.4. флуширование БД осуществляется автоматически при завершении транзакции.

Включение режима автоматического флуширования не сбрасывает на диск страницы, которые в данный момент находятся в кэше.

Возвращает:

Предыдущее значение режима автоматического флуширования.

Аргументы:

logic_name	Логическое имя БД, на которую осуществляется воздействие.
is_on	Если true, то после завершения каждой операции, изменяющей БД, будет просходить сброс всех "грязных" страниц кэша на диск.

Замещается в std_localhost_t.

virtual impl::response_t* process

(

const impl::request_t &

req

)

[pure virtual]

Обработать запрос и отдать результат.

Возвращается указатель на динамически-созданный объект response, который должен быть удален посредством delete.

Замещается в std_localhost_t.

---

Объявления и описания членов классов находятся в файлах:

• oess_1/db/site/h/localhost.hpp
• oess_1/db/site/localhost.cpp

---