public static final class ExecuteSqlRequest.QueryOptions.Builder extends GeneratedMessageV3.Builder<ExecuteSqlRequest.QueryOptions.Builder> implements ExecuteSqlRequest.QueryOptionsOrBuilder
Query optimizer configuration.
Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryOptions
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.QueryOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public ExecuteSqlRequest.QueryOptions build()
Returns
buildPartial()
public ExecuteSqlRequest.QueryOptions buildPartial()
Returns
clear()
public ExecuteSqlRequest.QueryOptions.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public ExecuteSqlRequest.QueryOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecuteSqlRequest.QueryOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearOptimizerStatisticsPackage()
public ExecuteSqlRequest.QueryOptions.Builder clearOptimizerStatisticsPackage()
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:
<code><code>
ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
</code></code><code>
The list of available statistics packages can be queried from
</code>INFORMATION_SCHEMA.SPANNER_STATISTICS<code>.
Executing a SQL statement with an invalid optimizer statistics package
or with a statistics package that allows garbage collection fails with
an </code>INVALID_ARGUMENT error.
string optimizer_statistics_package = 2;
clearOptimizerVersion()
public ExecuteSqlRequest.QueryOptions.Builder clearOptimizerVersion()
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.
string optimizer_version = 1;
clone()
public ExecuteSqlRequest.QueryOptions.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getOptimizerStatisticsPackage()
public String getOptimizerStatisticsPackage()
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:
<code><code>
ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
</code></code><code>
The list of available statistics packages can be queried from
</code>INFORMATION_SCHEMA.SPANNER_STATISTICS<code>.
Executing a SQL statement with an invalid optimizer statistics package
or with a statistics package that allows garbage collection fails with
an </code>INVALID_ARGUMENT error.
string optimizer_statistics_package = 2;
| Type | Description |
| String | The optimizerStatisticsPackage.
|
getOptimizerStatisticsPackageBytes()
public ByteString getOptimizerStatisticsPackageBytes()
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:
<code><code>
ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
</code></code><code>
The list of available statistics packages can be queried from
</code>INFORMATION_SCHEMA.SPANNER_STATISTICS<code>.
Executing a SQL statement with an invalid optimizer statistics package
or with a statistics package that allows garbage collection fails with
an </code>INVALID_ARGUMENT error.
string optimizer_statistics_package = 2;
| Type | Description |
| ByteString | The bytes for optimizerStatisticsPackage.
|
getOptimizerVersion()
public String getOptimizerVersion()
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.
string optimizer_version = 1;
| Type | Description |
| String | The optimizerVersion.
|
getOptimizerVersionBytes()
public ByteString getOptimizerVersionBytes()
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.
string optimizer_version = 1;
| Type | Description |
| ByteString | The bytes for optimizerVersion.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeFrom(ExecuteSqlRequest.QueryOptions other)
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(ExecuteSqlRequest.QueryOptions other)
Parameter
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.QueryOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.QueryOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setOptimizerStatisticsPackage(String value)
public ExecuteSqlRequest.QueryOptions.Builder setOptimizerStatisticsPackage(String value)
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:
<code><code>
ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
</code></code><code>
The list of available statistics packages can be queried from
</code>INFORMATION_SCHEMA.SPANNER_STATISTICS<code>.
Executing a SQL statement with an invalid optimizer statistics package
or with a statistics package that allows garbage collection fails with
an </code>INVALID_ARGUMENT error.
string optimizer_statistics_package = 2;
| Name | Description |
| value | String
The optimizerStatisticsPackage to set.
|
Returns
setOptimizerStatisticsPackageBytes(ByteString value)
public ExecuteSqlRequest.QueryOptions.Builder setOptimizerStatisticsPackageBytes(ByteString value)
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:
<code><code>
ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
</code></code><code>
The list of available statistics packages can be queried from
</code>INFORMATION_SCHEMA.SPANNER_STATISTICS<code>.
Executing a SQL statement with an invalid optimizer statistics package
or with a statistics package that allows garbage collection fails with
an </code>INVALID_ARGUMENT error.
string optimizer_statistics_package = 2;
| Name | Description |
| value | ByteString
The bytes for optimizerStatisticsPackage to set.
|
Returns
setOptimizerVersion(String value)
public ExecuteSqlRequest.QueryOptions.Builder setOptimizerVersion(String value)
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.
string optimizer_version = 1;
| Name | Description |
| value | String
The optimizerVersion to set.
|
Returns
setOptimizerVersionBytes(ByteString value)
public ExecuteSqlRequest.QueryOptions.Builder setOptimizerVersionBytes(ByteString value)
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.
string optimizer_version = 1;
| Name | Description |
| value | ByteString
The bytes for optimizerVersion to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecuteSqlRequest.QueryOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.QueryOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
