Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further update to SessionConfig.withDatabase documentation #1337

Merged
merged 1 commit into from
Nov 25, 2022
Merged

Further update to SessionConfig.withDatabase documentation #1337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions driver/src/main/java/org/neo4j/driver/SessionConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,12 +248,13 @@ public Builder withDefaultAccessMode(AccessMode mode) {
/**
* Sets target database name for queries executed within session.
* <p>
* This option has no explicit value by default, but it is recommended to set one if the target database is
* known in advance. This has the benefit of ensuring a consistent target database name throughout the session
* in a straightforward way and potentially simplifies driver logic as well as reduces network communication
* resulting in better performance.
* This option has no explicit value by default, as such it is recommended to set a value if the target database
* is known in advance. This has the benefit of ensuring a consistent target database name throughout the
* session in a straightforward way and potentially simplifies driver logic, which reduces network communication
* and might result in better performance.
* <p>
* Usage of Cypher clauses like USE is not a replacement for this option. Driver sends Cypher to the server for processing.
* Cypher clauses such as USE are not a replacement for this option as Cypher is handled by the server and not
* the driver.
* <p>
* When no explicit name is set, the driver behavior depends on the connection URI scheme supplied to the driver
* on instantiation and Bolt protocol version.
Expand Down