SessionConfig Class |
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.
Inheritance HierarchyNamespace: Neo4j.Driver
Assembly: Neo4j.Driver (in Neo4j.Driver.dll) Version: 5.0
SyntaxThe SessionConfig type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | 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.
Remarks
The default access mode set is overriden when transaction functions (i.e.
ExecuteReadAsyncTResult(FuncIAsyncQueryRunner, TaskTResult, ActionTransactionConfigBuilder)
and
ExecuteWriteAsyncTResult(FuncIAsyncQueryRunner, TaskTResult, ActionTransactionConfigBuilder)
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.
|
Methods| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT | Overloaded. A helper method to explicitly cast the value streamed back via Bolt to a local type. (Defined by ValueExtensions.) |
| AsT(T) | Overloaded.
A helper method to explicitly cast the value streamed back via Bolt to a local type, with default fallback
value.
(Defined by ValueExtensions.) |
See Also