sparksee.Database Class Reference

Database class. More...

List of all members.

Public Member Functions

def disable_rollback
 Disables the rollback mechanism.
def fix_current_cache_max_size
 Sets the cache maximum size to the current cache size in use.
def get_alias
 Gets the alias of the Database.
def get_path
 Gets the path of the Database.
def enable_rollback
 Enables the rollback mechanism.
def is_closed
 Gets if Database instance has been closed or not.
def new_session
 Creates a new Session.
def get_cache_max_size
 Gets the cache maximum size (in MB).
def set_cache_max_size
 Sets the cache maximum size (in MB).
def close
 Closes the Database instance.
def get_statistics
 Gets Database statistics.


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

def sparksee.Database.fix_current_cache_max_size (   self  ) 

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

Returns:
Returns true if successful or false otherwise.

def sparksee.Database.get_alias (   self  ) 

Gets the alias of the Database.

Returns:
The alias of the Database.

def sparksee.Database.get_path (   self  ) 

Gets the path of the Database.

Returns:
The path of the Database.

def sparksee.Database.is_closed (   self  ) 

Gets if Database instance has been closed or not.

See also:
close()
Returns:
TRUE if the Database instance has been closed, FALSE otherwise.

def sparksee.Database.get_cache_max_size (   self  ) 

Gets the cache maximum size (in MB).

Returns:
Returns the current cache max size.

def sparksee.Database.set_cache_max_size (   self,
  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.

def sparksee.Database.close (   self  ) 

Closes the Database instance.

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

def sparksee.Database.get_statistics (   self,
  stats 
)

Gets Database statistics.

Parameters:
stats [out] The DatabaseStatistics instance.


Generated on Fri Sep 12 13:39:46 2014 for SparkseePython by  doxygen 1.5.6