Database Class Reference

Database class. More...

Inheritance diagram for Database:

Collaboration diagram for Database:

Public Member Functions
virtual	~Database ()
	Destructor.
const std::wstring &	GetAlias () const
	Gets the alias of the Database. More...
const std::wstring &	GetPath () const
	Gets the path of the Database. More...
Session *	NewSession ()
	Creates a new Session.
void	EnableRollback ()
	Enables the rollback mechanism.
void	DisableRollback ()
	Disables the rollback mechanism.
void	GetStatistics (DatabaseStatistics &stats)
	Gets Database statistics. More...
int32_t	GetCacheMaxSize ()
	Gets the cache maximum size (in MB). More...
void	SetCacheMaxSize (int32_t megaBytes)
	Sets the cache maximum size (in MB). More...
void	FixCurrentCacheMaxSize ()
	Sets the cache maximum size to the current cache size in use.
void	DumpSchema (const std::wstring &filePath)
	Dump the database schema to the given file using the Sparksee scripting format.
void	RedoPrecommitted (int64_t txId)
	Redo a pending precommitted transaction recovered. More...

Private Member Functions
sparksee_core::GraphPool *	GetHandler ()
	Gets the handled reference. More...
const sparksee_core::GraphPool *	GetHandler () const
	Gets the handled reference. More...
void	SetHandler (sparksee_core::GraphPool *h)
	Sets the handled reference. More...
void	FreeHandler ()
	Frees (deletes) the handled reference.
bool_t	IsNull () const
	Gets if the handler is NULL. More...

Friends
class	Sparksee
class	Graph

Detailed Description

Database class.

All the data of the Database is stored into a persistent file which just can be created or open through a Sparksee instance.

Also, all the manipulation of a Database must be done by means of a Session which can be initiated from a Database instance.

Multiple Databases do not share the memory, that is there is no negotiation among them. In those cases, memory must be prefixed for each Database. To do that, use the SPARKSEEConfig.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

const std::wstring& Database::GetAlias ( ) const

inline

Gets the alias of the Database.

Returns

The alias of the Database.

int32_t Database::GetCacheMaxSize

(

)

Gets the cache maximum size (in MB).

Returns

Returns the current cache max size.

const std::wstring& Database::GetPath ( ) const

inline

Gets the path of the Database.

Returns

The path of the Database.

References END_SPARKSEE_GDB_NAMESPACE.

void Database::GetStatistics

(

DatabaseStatistics &

stats

)

Gets Database statistics.

Parameters

stats

[out] The DatabaseStatistics instance.

void Database::RedoPrecommitted

(

int64_t

txId

)

Redo a pending precommitted transaction recovered.

YOU SHOULD NOT USE THIS METHOD. This method only exists for a specific service.

void Database::SetCacheMaxSize

(

int32_t

megaBytes

)

Sets the cache maximum size (in MB).

0 means unlimited which is all the physical memory of the computer minus a small margin.

Parameters

megaBytes

[in] The new cache max size.

---

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

• Database.h