Database Class Reference
[Gdb]

Database class. More...

Inheritance diagram for Database:

Inheritance graph
Collaboration diagram for Database:

Collaboration graph

List of all members.

Public Member Functions

virtual ~Database ()
 Destructor.
const std::wstring & GetAlias () const
 Gets the alias of the Database.
const std::wstring & GetPath () const
 Gets the path of the Database.
SessionNewSession ()
 Creates a new Session.
void EnableRollback ()
 Enables the rollback mechanism.
void DisableRollback ()
 Disables the rollback mechanism.
void GetStatistics (DatabaseStatistics &stats)
 Gets Database statistics.
int32_t GetCacheMaxSize ()
 Gets the cache maximum size (in MB).
void SetCacheMaxSize (int32_t megaBytes)
 Sets the cache maximum size (in MB).
void FixCurrentCacheMaxSize ()
 Sets the cache maximum size to the current cache size in use.

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.

const std::wstring& Database::GetPath (  )  const [inline]

Gets the path of the Database.

Returns:
The path of the Database.

void Database::GetStatistics ( DatabaseStatistics stats  ) 

Gets Database statistics.

Parameters:
stats [out] The DatabaseStatistics instance.

int32_t Database::GetCacheMaxSize (  ) 

Gets the cache maximum size (in MB).

Returns:
Returns the current cache max size.

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.

void Database::FixCurrentCacheMaxSize (  ) 

Sets the cache maximum size to the current cache size in use.

Returns:
Returns true if successful or false otherwise.


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

Generated on Fri Sep 12 13:36:27 2014 for Sparksee by  doxygen 1.5.6