Class SessionConfig

Namespace

Neo4j.Driver

Assembly

Neo4j.Driver.dll

The interface that defines options applicable to session constructions. It could be populated by the provided builder-style methods. The default SessionConfig defines a Write session with the server default database using default fetch size specified in FetchSize.

public sealed class SessionConfig

Inheritance

object

SessionConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ValueExtensions.As<T>(object)

ValueExtensions.As<T>(object, T)

Properties

AuthToken

The auth token that will be used for this session. This overrides any auth settings on the driver object.

Bookmarks

The initial bookmarks to be used by the constructed session. The first transaction (either auto-commit or explicit) will ensure that the executing server is at least up to date to the point identified by the latest of the provided initial bookmarks. The bookmarks can be obtained from LastBookmarks (and corresponding properties in other types of sessions, i.e. IRxSession or ISession.

Database

Gets the target database name for queries executed within the constructed session.

DefaultAccessMode

The type of access required by the constructed session. This is used to route the requests originating from this session instance to the correct server in a clustered environment. The default access mode set is overriden when transaction functions (i.e. ExecuteReadAsync<TResult>(Func<IAsyncQueryRunner, Task<TResult>>, Action<TransactionConfigBuilder>) and ExecuteWriteAsync<TResult>(Func<IAsyncQueryRunner, Task<TResult>>, Action<TransactionConfigBuilder>) is used (with corresponding access modes derived from invoked method name).

FetchSize

The default fetch size. Since Bolt v4 (Neo4j 4.0+), the query running result (records) are pulled from server in batches. This fetch size defines how many records to pull in each batch. Use Infinite to disable batching and always pull all records in one batch instead.

ImpersonatedUser

Allows the specification of a username that the user wants to impersonate for the duration of the session. Once set this cannot be changed for the duration of the session's lifetime.

NotificationsConfig

The configuration for setting which notifications the server should send to the client for queries executed in the session.