Sparksee  5.2.0
STSDatabase Class Reference

Database class. More...

Inheritance diagram for STSDatabase:
Inheritance graph
Collaboration diagram for STSDatabase:
Collaboration graph

Instance Methods

(NSString *) - getAlias
 Gets the alias of the Database.
 
(NSString *) - getPath
 Gets the path of the Database.
 
(STSSession *) - createSession
 Creates a new Session.
 
(void) - enableRollback
 Enables the rollback mechanism.
 
(void) - disableRollback
 Disables the rollback mechanism.
 
(void) - getStatistics:
 Gets Database statistics.
 
(int) - getCacheMaxSize
 Gets the cache maximum size (in MB).
 
(void) - setCacheMaxSize:
 Sets the cache maximum size (in MB).
 
(void) - fixCurrentCacheMaxSize
 Sets the cache maximum size to the current cache size in use.
 
(void) - close
 Closes the Database instance.
 
(BOOL) - isClosed
 Check if the Database instance is closed.
 

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

Method Documentation

- (void) close

Closes the Database instance.

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

- (void) fixCurrentCacheMaxSize

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

Returns
Returns true if successful or false otherwise.
- (NSString*) getAlias

Gets the alias of the Database.

Returns
The alias of the Database.
- (int) getCacheMaxSize

Gets the cache maximum size (in MB).

Returns
Returns the current cache max size.
- (NSString*) getPath

Gets the path of the Database.

Returns
The path of the Database.
- (void) getStatistics: (STSDatabaseStatistics *)  stats

Gets Database statistics.

Parameters
stats[out] The DatabaseStatistics instance.
- (void) 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.

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