public sealed class QueryOptions : IEquatable<QueryOptions>Reference documentation and code samples for the Google.Cloud.Spanner.Data class QueryOptions.
Immutable class representing query options.
Implements
IEquatableQueryOptionsNamespace
Google.Cloud.Spanner.DataAssembly
Google.Cloud.Spanner.Data.dll
Properties
Empty
public static QueryOptions Empty { get; }Creates query options without specifying any options.
| Property Value | |
|---|---|
| Type | Description |
QueryOptions |
|
OptimizerStatisticsPackage
public string OptimizerStatisticsPackage { get; }The query optimizer statistics package configured in the options.
| Property Value | |
|---|---|
| Type | Description |
string |
|
OptimizerVersion
public string OptimizerVersion { get; }The query optimizer version configured in the options.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Methods
FromProto(QueryOptions)
public static QueryOptions FromProto(ExecuteSqlRequest.Types.QueryOptions proto)Set query options from the given proto.
| Parameter | |
|---|---|
| Name | Description |
proto |
Google.Cloud.Spanner.V1.ExecuteSqlRequestGoogle.Cloud.Spanner.V1.ExecuteSqlRequest.TypesGoogle.Cloud.Spanner.V1.ExecuteSqlRequest.Types.QueryOptionsThe proto to construct QueryOptions from. |
| Returns | |
|---|---|
| Type | Description |
QueryOptions |
|
The given proto should not be null. The given proto is cloned.
GetHashCode()
public override int GetHashCode()Serves as the default hash function.
| Returns | |
|---|---|
| Type | Description |
int |
A hash code for the current object. |
ToProto()
public ExecuteSqlRequest.Types.QueryOptions ToProto()Get proto version of the query options.
| Returns | |
|---|---|
| Type | Description |
Google.Cloud.Spanner.V1.ExecuteSqlRequestGoogle.Cloud.Spanner.V1.ExecuteSqlRequest.TypesGoogle.Cloud.Spanner.V1.ExecuteSqlRequest.Types.QueryOptions |
|
WithOptimizerStatisticsPackage(string)
public QueryOptions WithOptimizerStatisticsPackage(string optimizerStatisticsPackage)Clones the options and sets the optimizer statistics package to the given value.
| Parameter | |
|---|---|
| Name | Description |
optimizerStatisticsPackage |
stringOptimizer statistics package to set. |
| Returns | |
|---|---|
| Type | Description |
QueryOptions |
A clone of the options with the updated optimizer statistics package. |
The parameter allows individual queries to pick different query optimizer statistics packages.
Specifying "latest" as a value instructs Cloud Spanner to use the latest supported query optimizer statistics package. If not specified, Cloud Spanner uses the optimizer statistics package set at the database level options. Any other supported statistics package value overrides the default optimizer statistics package for query execution.
WithOptimizerVersion(string)
public QueryOptions WithOptimizerVersion(string optimizerVersion)Clones the options and sets the optimizer version to the given value.
| Parameter | |
|---|---|
| Name | Description |
optimizerVersion |
stringOptimizer version to set. |
| Returns | |
|---|---|
| Type | Description |
QueryOptions |
A clone of the options with the updated optimizer version. |
The 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.