Class: Google::Apis::SpannerV1::QueryOptions

Inherits:

Object

• Object
• Google::Apis::SpannerV1::QueryOptions

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb

Overview

Query optimizer configuration.

Instance Attribute Summary

• #optimizer_version ⇒ String

  An option to control the selection of optimizer version.

Instance Method Summary

• #initialize(**args) ⇒ QueryOptions constructor

  A new instance of QueryOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ QueryOptions

Returns a new instance of QueryOptions.

# File 'generated/google/apis/spanner_v1/classes.rb', line 2345

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#optimizer_version ⇒ 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 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 will fail with a syntax error (INVALID_ARGUMENT) status. 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. Corresponds to the JSON property optimizerVersion

Returns:

• (String)

# File 'generated/google/apis/spanner_v1/classes.rb', line 2343

def optimizer_version
  @optimizer_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/spanner_v1/classes.rb', line 2350

def update!(**args)
  @optimizer_version = args[:optimizer_version] if args.key?(:optimizer_version)
end