java.lang.Object
org.neo4j.driver.SessionConfig
- All Implemented Interfaces:
Serializable
The session configurations used to configure a session.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Builder used to configureSessionConfig
which will be used to create a session. -
Method Summary
Modifier and TypeMethodDescriptionABookmarkManager
implementation for the session to use.Returns the initial bookmarks.static SessionConfig.Builder
builder()
Creates a newSessionConfig.Builder
used to construct a configuration object.database()
The database where the session is going to connect to.The type of access required by units of work in this session, e.g.static SessionConfig
Returns a staticSessionConfig
with default values for a general purpose session.Returns a set of disabled notification classifications.boolean
This value if set, overrides the default fetch size set onConfig.fetchSize()
.static SessionConfig
forDatabase
(String database) Returns aSessionConfig
for the specified databaseint
hashCode()
The impersonated user the session is going to use for query execution.Returns a minimum notification severity.Returns notification config.toString()
-
Method Details
-
builder
Creates a newSessionConfig.Builder
used to construct a configuration object.- Returns:
- a session configuration builder.
-
defaultConfig
Returns a staticSessionConfig
with default values for a general purpose session.- Returns:
- a session config for a general purpose session.
-
forDatabase
Returns aSessionConfig
for the specified database- Parameters:
database
- the database the session binds to.- Returns:
- a session config for a session for the specified database.
-
bookmarks
Returns the initial bookmarks. First transaction in the session created with thisSessionConfig
will ensure that server hosting is at least as up-to-date as the latest transaction referenced by the supplied initial bookmarks.- Returns:
- the initial bookmarks.
-
defaultAccessMode
The type of access required by units of work in this session, e.g.read access
orwrite access
.- Returns:
- the access mode.
-
database
The database where the session is going to connect to.- Returns:
- the nullable database name where the session is going to connect to.
-
fetchSize
This value if set, overrides the default fetch size set onConfig.fetchSize()
.- Returns:
- an optional value of fetch size.
-
impersonatedUser
The impersonated user the session is going to use for query execution.- Returns:
- an optional value of the impersonated user.
-
bookmarkManager
ABookmarkManager
implementation for the session to use.- Returns:
- bookmark implementation
-
notificationConfig
Returns notification config.- Returns:
- the notification config
- Since:
- 5.7
-
minimumNotificationSeverity
@Preview(name="GQL-status object") public Optional<NotificationSeverity> minimumNotificationSeverity()Returns a minimum notification severity.- Returns:
- an
Optional
of minimumNotificationSeverity
or an emptyOptional
if it is not set - Since:
- 5.22.0
-
disabledNotificationClassifications
@Preview(name="GQL-status object") public Set<NotificationClassification> disabledNotificationClassifications()Returns a set of disabled notification classifications.- Returns:
- the
Set
of disabledNotificationClassification
- Since:
- 5.22.0
-
equals
-
hashCode
public int hashCode() -
toString
-