Skip to content

Commit 9b53df4

Browse files
authored
fix: add missing documentation for connection properties (#155)
Add documentation for properties that are supported for end users. This change does not add documentation for the userAgent property, as it is not a property that should be set by end users. This property should only be set by libraries that are maintained by Google. Fixes #152
1 parent 36612ee commit 9b53df4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@
8787
* connection. Default is true. @see {@link
8888
* com.google.cloud.spanner.jdbc.CloudSpannerJdbcConnection#setRetryAbortsInternally(boolean)}
8989
* for more information.
90+
* <li>numChannels (int): Sets the number of gRPC channels to use. Defaults to 4.
91+
* <li>usePlainText (boolean): Sets whether the JDBC connection should establish an unencrypted connection to the server. This option can only be used when connecting to a local emulator that does not require an encrypted connection, and that does not require authentication.
9092
* <li>optimizerVersion (string): The query optimizer version to use for the connection. The value must be either a valid version number or <code>LATEST</code>. If no value is specified, the query optimizer version specified in the environment variable <code>SPANNER_OPTIMIZER_VERSION<code> will be used. If no query optimizer version is specified in the connection URL or in the environment variable, the default query optimizer version of Cloud Spanner will be used.
9193
* </ul>
9294
*/

0 commit comments

Comments
 (0)