Session class. More...

Public Member Functions
	rollback (self)
	Rollbacks a transaction.
	pre_commit (self)
	PreCommits a transaction.
	begin (self)
	Begins a transaction.
	begin_update (self)
	Begins an update transaction.
	new_query (self, lang)
	Creates a new Query.
	commit (self)
	Commits a transaction.
	get_graph (self)
	Gets the Graph instance.
	close (self)
	Closes the Session instance.
	new_objects (self)
	Creates a new Objects instance.
	get_in_memory_pool_capacity (self)
	Gets the capacity of the in-memory pool.
	is_closed (self)
	Gets if Session instance has been closed or not.

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

◆ close()

sparksee.Session.close ( self )

Closes the Session instance.

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

◆ get_graph()

sparksee.Session.get_graph ( self )

Gets the Graph instance.

Returns: The Graph instance.

◆ get_in_memory_pool_capacity()

sparksee.Session.get_in_memory_pool_capacity ( self )

Gets the capacity of the in-memory pool.

Returns: Returns the capacity of the in-memory pool

◆ is_closed()

sparksee.Session.is_closed ( self )

Gets if Session instance has been closed or not.

See also: close()

Returns: TRUE if the Session instance has been closed, FALSE otherwise.

◆ new_objects()

sparksee.Session.new_objects ( self )

Creates a new Objects instance.

Returns: The new Objects instance.

◆ new_query()

sparksee.Session.new_query	(		self,
			lang )

Creates a new Query.

Parameters

lang	The query language to create the query for

Returns: A new Query instance.

◆ pre_commit()

sparksee.Session.pre_commit ( self )

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.

Public Member Functions