From 8bfe704d482bdcdc64a057b09f8fc1a764d2e23e Mon Sep 17 00:00:00 2001 From: Olav Loite Date: Wed, 3 Feb 2021 12:08:14 +0100 Subject: [PATCH 1/2] docs: fix javadoc formatting One of the descriptions of the supported connection properties missed an ending block, which caused the entire formatting to be incorrect. Fixes #342 --- .../com/google/cloud/spanner/jdbc/JdbcDriver.java | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java b/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java index d2a2fea2..5aeda53a 100644 --- a/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java +++ b/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java @@ -89,8 +89,15 @@ * com.google.cloud.spanner.jdbc.CloudSpannerJdbcConnection#setRetryAbortsInternally(boolean)} * for more information. *
  • numChannels (int): Sets the number of gRPC channels to use. Defaults to 4. - *
  • 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. - *
  • optimizerVersion (string): The query optimizer version to use for the connection. The value must be either a valid version number or LATEST. If no value is specified, the query optimizer version specified in the environment variable SPANNER_OPTIMIZER_VERSION 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. + *
  • 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. + *
  • optimizerVersion (string): The query optimizer version to use for the connection. The value + * must be either a valid version number or LATEST. If no value is specified, the + * query optimizer version specified in the environment variable + * SPANNER_OPTIMIZER_VERSION 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. * */ public class JdbcDriver implements Driver { From ad7e4272629344ef7e361af2b86b83262eab7dff Mon Sep 17 00:00:00 2001 From: Olav Loite Date: Thu, 4 Feb 2021 09:04:26 +0100 Subject: [PATCH 2/2] fix: 'will be' => 'is' --- .../java/com/google/cloud/spanner/jdbc/JdbcDriver.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java b/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java index 5aeda53a..f7214ea7 100644 --- a/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java +++ b/src/main/java/com/google/cloud/spanner/jdbc/JdbcDriver.java @@ -67,7 +67,7 @@ * The property-value strings should be url-encoded. * *

    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. * *

    The supported properties are: @@ -75,7 +75,7 @@ *

      *
    • 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. *
    • 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 @@ -95,9 +95,9 @@ *
    • optimizerVersion (string): The query optimizer version to use for the connection. The value * must be either a valid version number or LATEST. If no value is specified, the * query optimizer version specified in the environment variable - * SPANNER_OPTIMIZER_VERSION 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. + * SPANNER_OPTIMIZER_VERSION 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. *
    */ public class JdbcDriver implements Driver {