Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions (v1.0.2)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions.

Query optimizer configuration.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#optimizer_statistics_package

def optimizer_statistics_package() -> ::String
Returns
  • (::String) — 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.

#optimizer_statistics_package=

def optimizer_statistics_package=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#optimizer_version

def optimizer_version() -> ::String
Returns
  • (::String) — 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.

#optimizer_version=

def optimizer_version=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.