org.neo4j.driver.v1

Interface Session

All Superinterfaces:

AutoCloseable, org.neo4j.driver.v1.util.Resource, StatementRunner

public interface Session
extends org.neo4j.driver.v1.util.Resource, StatementRunner

A live session with a Neo4j instance.

Sessions serve two purposes. For one, they are an optimization. By keeping state on the database side, we can avoid re-transmitting certain metadata over and over.

Sessions also serve a role in transaction isolation and ordering semantics. Neo4j requires "sticky sessions", meaning all requests within one session must always go to the same Neo4j instance.

Session objects are not thread safe, if you want to run concurrent operations against the database, simply create multiple sessions objects.

Important note on semantics

Please see the section under StatementRunner for an important overview of the guarantees the session gives you around when statements are executed.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
Transaction	beginTransaction() Begin a new transaction in this session.
void	close() Signal that you are done using this session.

Methods inherited from interface org.neo4j.driver.v1.util.Resource

isOpen

Methods inherited from interface org.neo4j.driver.v1.StatementRunner

run, run, run, run, run, typeSystem

Method Detail

beginTransaction

Transaction beginTransaction()

Begin a new transaction in this session. A session can have at most one transaction running at a time, if you want to run multiple concurrent transactions, you should use multiple concurrent sessions.

All data operations in Neo4j are transactional. However, for convenience we provide a StatementRunner.run(String) method directly on this session interface as well. When you use that method, your statement automatically gets wrapped in a transaction.

If you want to run multiple statements in the same transaction, you should wrap them in a transaction using this method.

Returns:

a new transaction

close

void close()

Signal that you are done using this session. In the default driver usage, closing and accessing sessions is very low cost, because sessions are pooled by Driver. When this method returns, all outstanding statements in the session are guaranteed to have completed, meaning any writes you performed are guaranteed to be durably stored.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.neo4j.driver.v1.util.Resource