sparksee.Database Class Reference

Database class. More...

Public Member Functions
def	dump_schema (self, file_path)
	Dump the database schema to the given file using the Sparksee scripting format. More...
def	new_session (self)
	Creates a new Session.
def	get_path (self)
	Gets the path of the Database. More...
def	enable_rollback (self)
	Enables the rollback mechanism.
def	fix_current_cache_max_size (self)
	Sets the cache maximum size to the current cache size in use.
def	redo_precommitted (self, tx_id)
	Redo a pending precommitted transaction recovered. More...
def	get_statistics (self, stats)
	Gets Database statistics. More...
def	set_cache_max_size (self, mega_bytes)
	Sets the cache maximum size (in MB). More...
def	disable_rollback (self)
	Disables the rollback mechanism.
def	close (self)
	Closes the Database instance. More...
def	get_alias (self)
	Gets the alias of the Database. More...
def	get_cache_max_size (self)
	Gets the cache maximum size (in MB). More...
def	is_closed (self)
	Gets if Database instance has been closed or not. 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

def sparksee.Database.close

(

self

)

Closes the Database instance.

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

def sparksee.Database.dump_schema	(		self,
			file_path
	)

Dump the database schema to the given file using the Sparksee scripting format.

Parameters

file_path

null

def sparksee.Database.get_alias

(

self

)

Gets the alias of the Database.

Returns

The alias of the Database.

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.get_path

(

self

)

Gets the path of the Database.

Returns

The path of the Database.

def sparksee.Database.get_statistics	(		self,
			stats
	)

Gets Database statistics.

Parameters

stats

[out] The DatabaseStatistics instance.

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.redo_precommitted	(		self,
			tx_id
	)

Redo a pending precommitted transaction recovered.

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

Parameters

tx_id

null

def sparksee.Database.set_cache_max_size	(		self,
			mega_bytes
	)

Sets the cache maximum size (in MB).

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

Parameters

mega_bytes

[in] The new cache max size.