#include <Session.h>

Inheritance diagram for Session:

Collaboration diagram for Session:

Public Member Functions
virtual	~Session ()
	Destructor.
Graph *	GetGraph ()
	Gets the Graph instance.
Objects *	NewObjects ()
	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.
Query *	NewQuery (sparksee::gdb::QueryLanguage lang)
	Creates a new Query.
int64_t	PreCommit ()
	PreCommits a transaction.
int64_t	GetInMemoryPoolCapacity ()
	Gets the capacity of the in-memory pool.

Friends
class	Database
class	Graph
class	Objects
class	ObjectsIterator
class	KeyValues
class	Values
class	ValuesIterator
class	TextStream
class	ValueArray

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

Member Function Documentation

◆ GetGraph()

Graph * Session::GetGraph ( )

Gets the Graph instance.

Returns: The Graph instance.

◆ GetInMemoryPoolCapacity()

int64_t Session::GetInMemoryPoolCapacity ( )

Gets the capacity of the in-memory pool.

Returns: Returns the capacity of the in-memory pool

◆ NewObjects()

Objects * Session::NewObjects ( )

Creates a new Objects instance.

Returns: The new Objects instance.

◆ NewQuery()

Query * Session::NewQuery ( sparksee::gdb::QueryLanguage lang )

Creates a new Query.

Parameters

lang	The query language to create the query for

Returns: A new Query instance.

◆ PreCommit()

int64_t Session::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.

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

Session.h

Public Member Functions