Класс local_db_t

#include <local_db.hpp>

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

---

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

Класс, для упрощения создания объекта по работе с локальной базой данных.

Начиная с:

v.1.1.0

Класс для:

• создания объекта localhost и описания в localhost базы данных;
• создания объекта localhost_connector для localhost;
• создания объекта db и открытия описанной в localhost базы данных.

Все действия по открытию БД осуществляются в конструкторе. Возникающие исключения не обрабатываются. Поэтому, при возникновении исключений объект local_db_t не создается.

Примеры:

sample/app_recovery/main.cpp, sample/db_copy_content/main.cpp и sample/file_archive_2/main.cpp.

Открытые типы
	auto_create = 0x1
	Попытаться физически создать БД.
	no_overwrite = 0x2
	существует, то не пересоздавать существующую БД.
	auto_flush_mode = 0x4
	каждой транзакции.
	read_only_mode = 0x8
	совместим с режимом auto_create.
enum	{ auto_create = 0x1, no_overwrite = 0x2, auto_flush_mode = 0x4, read_only_mode = 0x8 }
	при открытии БД. Подробнее...
Открытые члены
	local_db_t (const std::string &phys_db_name, unsigned int initial_actions=auto_create|no_overwrite) throw ( std::exception )
	Конструктор пытается открыть БД. Возникающие исключения выпускаются наружу.
	local_db_t (const std::string &physic_name, const oess_1::db::storage::config_t &config, unsigned int initial_actions=auto_create|no_overwrite) throw ( std::exception )
	Конструктор с возможностью задания конфигурации БД.
	~local_db_t () throw ()
oess_1::db::cln::db_t *	query_db () throw ()
Закрытые члены
	local_db_t (const local_db_t &)
local_db_t &	operator= (const local_db_t &)
Закрытые данные
auto_ptr_3::obj_ptr_t< oess_1::db::site::localhost_t >	m_localhost
auto_ptr_3::obj_ptr_t< oess_1::db::cln::db_t >	m_db

---

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

anonymous enum

при открытии БД.

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

auto_create	Попытаться физически создать БД.
no_overwrite	существует, то не пересоздавать существующую БД. Имеет смысл только в сочетании с auto_create.
auto_flush_mode	каждой транзакции. Уст.: БД автоматически флушируется при завершении
read_only_mode	совместим с режимом auto_create.

---

Конструктор(ы)

local_db_t	(	const std::string &	phys_db_name,
		unsigned int	initial_actions = auto_create|no_overwrite
	)			throw ( std::exception )

Конструктор пытается открыть БД. Возникающие исключения выпускаются наружу.

Аргументы:

phys_db_name	Физическое имя БД.
initial_actions	Битовая маска флагов, определяющая действия, которые нужно выполнить над БД при открытии.

local_db_t	(	const std::string &	physic_name,
		const oess_1::db::storage::config_t &	config,
		unsigned int	initial_actions = auto_create|no_overwrite
	)			throw ( std::exception )

Конструктор с возможностью задания конфигурации БД.

Начиная с:

v.1.4.0

Возникающие исключения выпускаются наружу.

Аргументы:

physic_name	Физическое имя БД.
config	Конфигурация для БД.
initial_actions	Битовая маска флагов, определяющая действия, которые нужно выполнить над БД при открытии.

~local_db_t

(

)

throw ()

Деструктор закрывает БД и обнуляет указатель на объект db.

---

Методы

oess_1::db::cln::db_t * query_db

(

)

throw ()

Получение указателя на объект db.

---

Данные класса

auto_ptr_3::obj_ptr_t< oess_1::db::cln::db_t > m_db [private]

Объект для работы с БД.

auto_ptr_3::obj_ptr_t< oess_1::db::site::localhost_t > m_localhost [private]

Менеджер базы данных.

---

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

• oess_1/db/cln/h/local_db.hpp
• oess_1/db/cln/local_db.cpp

---