Show / Hide Table of Contents

Class QueryOptions

Query optimizer configuration.

Inheritance
object
QueryOptions
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Spanner.v1.Data
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class QueryOptions : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

OptimizerStatisticsPackage

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 isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement:

sql ALTER STATISTICS 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.

Declaration
[JsonProperty("optimizerStatisticsPackage")]
public virtual string OptimizerStatisticsPackage { get; set; }
Property Value
Type Description
string

OptimizerVersion

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.

Declaration
[JsonProperty("optimizerVersion")]
public virtual string OptimizerVersion { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX