STSDatabase Class Reference

Database class. More...

#include <Sparksee.h>

Inheritance diagram for STSDatabase:

Collaboration diagram for STSDatabase:

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)	- dumpSchema:
	Dump the database schema to the given file using the Sparksee scripting format.
(void)	- redoPrecommitted:
	Redo a pending precommitted transaction recovered.
(void)	- addQueryStreamManager:
	Add a QueryStreamManager to the database.
(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

addQueryStreamManager:

- (void) addQueryStreamManager:

(STSQueryStreamManager *)

queryStreamManager

Add a QueryStreamManager to the database.

The user is responsible of keeping the manager alive for the duration of the Database. The Managers will be used in reverse order of addition while searching for a matching Stream.

Parameters

queryStreamManager

[In] A reference to a QueryStreamManager

close

- (void) close

Closes the Database instance.

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

References close.

Referenced by close.

createSession

- (STSSession *) createSession

Creates a new Session.

Returns

A new Session instance.

References createSession.

Referenced by createSession.

dumpSchema:

- (void) dumpSchema:

(NSString *)

filePath

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

Parameters

filePath

null

getAlias

- (NSString *) getAlias

Gets the alias of the Database.

Returns

The alias of the Database.

References getAlias.

Referenced by getAlias.

getCacheMaxSize

- (int) getCacheMaxSize

Gets the cache maximum size (in MB).

Returns

Returns the current cache max size.

References getCacheMaxSize.

Referenced by getCacheMaxSize.

getPath

- (NSString *) getPath

Gets the path of the Database.

Returns

The path of the Database.

References getPath.

Referenced by getPath.

getStatistics:

- (void) getStatistics:

(STSDatabaseStatistics *)

stats

Gets Database statistics.

Parameters

stats

[out] The DatabaseStatistics instance.

redoPrecommitted:

- (void) redoPrecommitted:

(long long)

txId

Redo a pending precommitted transaction recovered.

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

Parameters

txId

null

setCacheMaxSize:

- (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:

• Sparksee.h