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

Jump to bottom

docs: fix javadoc formatting #343

Merged
merged 2 commits into from Feb 8, 2021
Merged

docs: fix javadoc formatting #343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bfe704
docs: fix javadoc formatting
olavloite Feb 3, 2021
ad7e427
fix: 'will be' => 'is'
olavloite Feb 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java
View file
Open in desktop
Expand Up @@ -67,15 +67,15 @@
* The property-value strings should be url-encoded.
*
* <p>The project-id part of the URI may be filled with the placeholder DEFAULT_PROJECT_ID. This
* placeholder will be replaced by the default project id of the environment that is requesting a
* placeholder is replaced by the default project id of the environment that is requesting a
* connection.
*
* <p>The supported properties are:
*
* <ul>
* <li>credentials (String): URL for the credentials file to use for the connection. If you do not
* specify any credentials at all, the default credentials of the environment as returned by
* {@link GoogleCredentials#getApplicationDefault()} will be used.
* {@link GoogleCredentials#getApplicationDefault()} is used.
* <li>oauthtoken (String): A valid OAuth2 token to use for the JDBC connection. The token must
* have been obtained with one or both of the scopes
* 'https://www.googleapis.com/auth/spanner.admin' and/or
Expand All @@ -89,8 +89,15 @@
* 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.
* <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> is 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 is used.
* </ul>
*/
public class JdbcDriver implements Driver {
Expand Down