Class: Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions

Inherits:

Object

Object
Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/spanner/v1/spanner.rb

Overview

Query optimizer configuration.

Instance Attribute Summary collapse

#optimizer_statistics_package ⇒ ::String
An option to control the selection of optimizer statistics package.
#optimizer_version ⇒ ::String
An option to control the selection of optimizer version.

Instance Attribute Details

#optimizer_statistics_package ⇒ `::String`

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

# File 'proto_docs/google/spanner/v1/spanner.rb', line 481

class QueryOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#optimizer_version ⇒ `::String`

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