org.neo4j.driver

Class SessionConfig.Builder

java.lang.Object

org.neo4j.driver.SessionConfig.Builder

Enclosing class:

SessionConfig

public static class SessionConfig.Builder
extends Object

Builder used to configure SessionConfig which will be used to create a session.

Method Summary

Modifier and Type	Method and Description
SessionConfig	build()
SessionConfig.Builder	withBookmarks(Bookmark... bookmarks) Set the initial bookmarks to be used in a session.
SessionConfig.Builder	withBookmarks(Iterable<Bookmark> bookmarks) Set the initial bookmarks to be used in a session.
SessionConfig.Builder	withDatabase(String database) Set the database that the newly created session is going to connect to.
SessionConfig.Builder	withDefaultAccessMode(AccessMode mode) Set the type of access required by units of work in this session, e.g.
SessionConfig.Builder	withFetchSize(long size) Specify how many records to fetch in each batch for this session.
SessionConfig.Builder	withImpersonatedUser(String impersonatedUser) Set the impersonated user that the newly created session is going to use for query execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withBookmarks

public SessionConfig.Builder withBookmarks(Bookmark... bookmarks)

Set the initial bookmarks to be used in a session.

First transaction in a session will ensure that server hosting is at least as up-to-date as the latest transaction referenced by the supplied bookmarks. The bookmarks can be obtained via Session.lastBookmark(), AsyncSession.lastBookmark(), and/or RxSession.lastBookmark().

Parameters:

bookmarks - a series of initial bookmarks. Both null value and empty array are permitted, and indicate that the bookmarks do not exist or are unknown.

Returns:

this builder.

withBookmarks

public SessionConfig.Builder withBookmarks(Iterable<Bookmark> bookmarks)

Set the initial bookmarks to be used in a session. First transaction in a session will ensure that server hosting is at least as up-to-date as the latest transaction referenced by the supplied bookmarks. The bookmarks can be obtained via Session.lastBookmark(), AsyncSession.lastBookmark(), and/or RxSession.lastBookmark().

Parameters:

bookmarks - initial references to some previous transactions. Both null value and empty iterable are permitted, and indicate that the bookmarks do not exist or are unknown.

Returns:

this builder

withDefaultAccessMode

public SessionConfig.Builder withDefaultAccessMode(AccessMode mode)

Set the type of access required by units of work in this session, e.g. read access or write access. This access mode is used to route transactions in the session to the server who has the right to carry out the specified operations.

Parameters:

mode - access mode.

Returns:

this builder.

withDatabase

public SessionConfig.Builder withDatabase(String database)

Set the database that the newly created session is going to connect to.

For connecting to servers that support multi-databases, it is highly recommended to always set the database explicitly in the SessionConfig for each session. If the database name is not set, then session defaults to connecting to the default database configured in server configuration.

For servers that do not support multi-databases, leave this database value unset. The only database will be used instead.

Parameters:

database - the database the session going to connect to. Provided value should not be null.

Returns:

this builder.

withFetchSize

public SessionConfig.Builder withFetchSize(long size)

Specify how many records to fetch in each batch for this session. This config will overrides the default value set on Config.fetchSize(). This config is only valid when the driver is used with servers that support Bolt V4 (Server version 4.0 and later). Bolt V4 enables pulling records in batches to allow client to take control of data population and apply back pressure to server. This config specifies the default fetch size for all query runs using Session and AsyncSession. By default, the value is set to 1000. Use -1 to disables back pressure and config client to pull all records at once after each run. This config only applies to run result obtained via Session and AsyncSession. As with RxSession, the batch size is provided via Subscription.request(long) instead.

Parameters:

size - the default record fetch size when pulling records in batches using Bolt V4.

Returns:

this builder

withImpersonatedUser

public SessionConfig.Builder withImpersonatedUser(String impersonatedUser)

Set the impersonated user that the newly created session is going to use for query execution.

The principal provided to the driver on creation must have the necessary permissions to impersonate and run queries as the impersonated user.

When withDatabase(String) is not used, the driver will discover the default database name of the impersonated user on first session usage. From that moment, the discovered database name will be used as the default database name for the whole lifetime of the new session.

Compatible with 4.4+ only. You MUST have all servers running 4.4 version or above and communicating over Bolt 4.4 or above.

Parameters:

impersonatedUser - the user to impersonate. Provided value should not be null.

Returns:

this builder

build

public SessionConfig build()