Skip to content

Commit

Permalink
fix: add missing documentation for connection properties (#155)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
olavloite committed Jun 17, 2020
1 parent 36612ee commit 9b53df4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java
Expand Up @@ -87,6 +87,8 @@
* connection. Default is true. @see {@link
* com.google.cloud.spanner.jdbc.CloudSpannerJdbcConnection#setRetryAbortsInternally(boolean)}
* for more information.
* <li>numChannels (int): Sets the number of gRPC channels to use. Defaults to 4.
* <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.
* <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.
* </ul>
*/
Expand Down

0 comments on commit 9b53df4

Please sign in to comment.