Session class. More...

#include <Sparksee.h>

Inheritance diagram for STSSession:

Collaboration diagram for STSSession:

Instance Methods
(STSGraph *)	- getGraph
	Gets the Graph instance.
(STSObjects *)	- createObjects
	Creates a new Objects instance.
(void)	- begin
	Begins a transaction.
(void)	- beginUpdate
	Begins an update transaction.
(void)	- commit
	Commits a transaction.
(void)	- rollback
	Rollbacks a transaction.
(STSQuery *)	- createQuery:
	Creates a new Query.
(long long)	- preCommit
	PreCommits a transaction.
(long long)	- getInMemoryPoolCapacity
	Gets the capacity of the in-memory pool.
(void)	- close
	Closes the Session instance.
(BOOL)	- isClosed
	Check if the Session instance is closed.

Detailed Description

Session class.

A Session is a stateful period of activity of a user with the Database.

All the manipulation of a Database must be enclosed into a Session. A Session can be initiated from a Database instance and allows for getting a Graph instance which represents the persistent graph (the graph database).

Also, temporary data is associated to the Session, thus when a Session is closed, all the temporary data associated to the Session is removed too. Objects or Values instances or even session attributes are an example of temporary data.

Moreover, a Session is exclusive for a thread, thus if it is shared among threads results may be fatal or unexpected.

Check out the 'Processing' and 'Transactions' sections in the SPARKSEE User Manual for details about how Sessions work and the use of transactions.

Author: Sparsity Technologies http://www.sparsity-technologies.com

Method Documentation

◆ close

- (void) close

Closes the Session instance.

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

References close.

Referenced by close.

◆ createObjects

- (STSObjects *) createObjects

Creates a new Objects instance.

Returns: The new Objects instance.

References createObjects.

Referenced by createObjects.

◆ createQuery:

- (STSQuery *) createQuery: (enum STSQueryLanguage) lang

Creates a new Query.

Parameters

lang	The query language to create the query for

Returns: A new Query instance.

◆ getGraph

- (STSGraph *) getGraph

Gets the Graph instance.

Returns: The Graph instance.

References getGraph.

Referenced by getGraph.

◆ getInMemoryPoolCapacity

- (long long) getInMemoryPoolCapacity

Gets the capacity of the in-memory pool.

Returns: Returns the capacity of the in-memory pool

References getInMemoryPoolCapacity.

Referenced by getInMemoryPoolCapacity.

◆ preCommit

- (long long) preCommit

PreCommits a transaction.

YOU SHOULD NOT USE THIS METHOD. This method exists for a specific service and it is used to force that the transaction is written in the recovery log even though it had not been committed yet (and may never be).

Returns: The transaction id. This has to be used in RedoPrecommited in case of a recovery process.

References preCommit.

Referenced by preCommit.

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

Sparksee.h

Instance Methods