SparkseeNet  5.1.0
Public Member Functions | List of all members
com.sparsity.sparksee.gdb.Database Class Reference

Database class. More...

Public Member Functions

void DisableRollback ()
 Disables the rollback mechanism.
 
boolean IsClosed ()
 Gets if Database instance has been closed or not. More...
 
void FixCurrentCacheMaxSize ()
 Sets the cache maximum size to the current cache size in use. More...
 
System.String GetAlias ()
 Gets the alias of the Database. More...
 
void Close ()
 Closes the Database instance. More...
 
System.String GetPath ()
 Gets the path of the Database. More...
 
void EnableRollback ()
 Enables the rollback mechanism.
 
com.sparsity.sparksee.gdb.Session NewSession ()
 Creates a new Session.
 
int GetCacheMaxSize ()
 Gets the cache maximum size (in MB). More...
 
void SetCacheMaxSize (int megaBytes)
 Sets the cache maximum size (in MB). More...
 
void GetStatistics (com.sparsity.sparksee.gdb.DatabaseStatistics stats)
 Gets Database statistics. More...
 

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

void com.sparsity.sparksee.gdb.Database.Close ( )

Closes the Database instance.

It must be called to ensure the integrity of all data.

void com.sparsity.sparksee.gdb.Database.FixCurrentCacheMaxSize ( )

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

Returns
Returns true if successful or false otherwise.
System.String com.sparsity.sparksee.gdb.Database.GetAlias ( )

Gets the alias of the Database.

Returns
The alias of the Database.
int com.sparsity.sparksee.gdb.Database.GetCacheMaxSize ( )

Gets the cache maximum size (in MB).

Returns
Returns the current cache max size.
System.String com.sparsity.sparksee.gdb.Database.GetPath ( )

Gets the path of the Database.

Returns
The path of the Database.
void com.sparsity.sparksee.gdb.Database.GetStatistics ( com.sparsity.sparksee.gdb.DatabaseStatistics  stats)

Gets Database statistics.

Parameters
stats[out] The DatabaseStatistics instance.
boolean com.sparsity.sparksee.gdb.Database.IsClosed ( )

Gets if Database instance has been closed or not.

See Also
Close()
Returns
TRUE if the Database instance has been closed, FALSE otherwise.
void com.sparsity.sparksee.gdb.Database.SetCacheMaxSize ( int  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.