Skip to content

Commit d11ce57

Browse files
committed
Further update to SessionConfig.withDatabase documentation (neo4j#1337)
1 parent e41d8d4 commit d11ce57

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

driver/src/main/java/org/neo4j/driver/SessionConfig.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,12 +226,13 @@ public Builder withDefaultAccessMode(AccessMode mode) {
226226
/**
227227
* Sets target database name for queries executed within session.
228228
* <p>
229-
* This option has no explicit value by default, but it is recommended to set one if the target database is
230-
* known in advance. This has the benefit of ensuring a consistent target database name throughout the session
231-
* in a straightforward way and potentially simplifies driver logic as well as reduces network communication
232-
* resulting in better performance.
229+
* This option has no explicit value by default, as such it is recommended to set a value if the target database
230+
* is known in advance. This has the benefit of ensuring a consistent target database name throughout the
231+
* session in a straightforward way and potentially simplifies driver logic, which reduces network communication
232+
* and might result in better performance.
233233
* <p>
234-
* Usage of Cypher clauses like USE is not a replacement for this option. Driver sends Cypher to the server for processing.
234+
* Cypher clauses such as USE are not a replacement for this option as Cypher is handled by the server and not
235+
* the driver.
235236
* <p>
236237
* When no explicit name is set, the driver behavior depends on the connection URI scheme supplied to the driver
237238
* on instantiation and Bolt protocol version.

0 commit comments

Comments
 (0)