Sparksee  5.2.0
STSSession Class Reference

Session class. More...

Inheritance diagram for STSSession:
Inheritance graph
Collaboration diagram for STSSession:
Collaboration graph

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

- (void) close

Closes the Session instance.

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

- (STSObjects*) createObjects

Creates a new Objects instance.

Returns
The new Objects instance.
- (STSGraph*) getGraph

Gets the Graph instance.

Returns
The Graph instance.

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