Package com.google.spanner.v1

Interface ExecuteSqlRequest.QueryOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ExecuteSqlRequest.QueryOptions, ExecuteSqlRequest.QueryOptions.Builder
Enclosing class:
ExecuteSqlRequest
public static interface ExecuteSqlRequest.QueryOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getOptimizerStatisticsPackage()
    An option to control the selection of optimizer statistics package.
    com.google.protobuf.ByteString
    getOptimizerStatisticsPackageBytes()
    An option to control the selection of optimizer statistics package.
    String
    getOptimizerVersion()
    An option to control the selection of optimizer version.
    com.google.protobuf.ByteString
    getOptimizerVersionBytes()
    An option to control the selection of optimizer version.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getOptimizerVersion

      String getOptimizerVersion()
       An option to control the selection of optimizer version.

 This parameter allows individual queries to pick different query
 optimizer versions.

 Specifying `latest` as a value instructs Cloud Spanner to use the
 latest supported query optimizer version. If not specified, Cloud Spanner
 uses the optimizer version set at the database level options. Any other
 positive integer (from the list of supported optimizer versions)
 overrides the default optimizer version for query execution.

 The list of supported optimizer versions can be queried from
 SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS.

 Executing a SQL statement with an invalid optimizer version fails with
 an `INVALID_ARGUMENT` error.

 See
 https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
 for more information on managing the query optimizer.

 The `optimizer_version` statement hint has precedence over this setting.
      string optimizer_version = 1;
      Returns:
      The optimizerVersion.

    • getOptimizerVersionBytes

      com.google.protobuf.ByteString getOptimizerVersionBytes()
       An option to control the selection of optimizer version.

 This parameter allows individual queries to pick different query
 optimizer versions.

 Specifying `latest` as a value instructs Cloud Spanner to use the
 latest supported query optimizer version. If not specified, Cloud Spanner
 uses the optimizer version set at the database level options. Any other
 positive integer (from the list of supported optimizer versions)
 overrides the default optimizer version for query execution.

 The list of supported optimizer versions can be queried from
 SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS.

 Executing a SQL statement with an invalid optimizer version fails with
 an `INVALID_ARGUMENT` error.

 See
 https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
 for more information on managing the query optimizer.

 The `optimizer_version` statement hint has precedence over this setting.
      string optimizer_version = 1;
      Returns:
      The bytes for optimizerVersion.

    • getOptimizerStatisticsPackage

      String getOptimizerStatisticsPackage()
       An option to control the selection of optimizer statistics package.

 This parameter allows individual queries to use a different query
 optimizer statistics package.

 Specifying `latest` as a value instructs Cloud Spanner to use the latest
 generated statistics package. If not specified, Cloud Spanner uses
 the statistics package set at the database level options, or the latest
 package if the database option is not set.

 The statistics package requested by the query has to be exempt from
 garbage collection. This can be achieved with the following DDL
 statement:

 ```
 ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
 ```

 The list of available statistics packages can be queried from
 `INFORMATION_SCHEMA.SPANNER_STATISTICS`.

 Executing a SQL statement with an invalid optimizer statistics package
 or with a statistics package that allows garbage collection fails with
 an `INVALID_ARGUMENT` error.
      string optimizer_statistics_package = 2;
      Returns:
      The optimizerStatisticsPackage.

    • getOptimizerStatisticsPackageBytes

      com.google.protobuf.ByteString getOptimizerStatisticsPackageBytes()
       An option to control the selection of optimizer statistics package.

 This parameter allows individual queries to use a different query
 optimizer statistics package.

 Specifying `latest` as a value instructs Cloud Spanner to use the latest
 generated statistics package. If not specified, Cloud Spanner uses
 the statistics package set at the database level options, or the latest
 package if the database option is not set.

 The statistics package requested by the query has to be exempt from
 garbage collection. This can be achieved with the following DDL
 statement:

 ```
 ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
 ```

 The list of available statistics packages can be queried from
 `INFORMATION_SCHEMA.SPANNER_STATISTICS`.

 Executing a SQL statement with an invalid optimizer statistics package
 or with a statistics package that allows garbage collection fails with
 an `INVALID_ARGUMENT` error.
      string optimizer_statistics_package = 2;
      Returns:
      The bytes for optimizerStatisticsPackage.