public static final class ExecuteSqlRequest.QueryOptions.Builder extends GeneratedMessageV3.Builder<ExecuteSqlRequest.QueryOptions.Builder> implements ExecuteSqlRequest.QueryOptionsOrBuilderQuery optimizer configuration.
Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryOptions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecuteSqlRequest.QueryOptions.BuilderImplements
ExecuteSqlRequest.QueryOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.QueryOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
build()
public ExecuteSqlRequest.QueryOptions build()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions | |
buildPartial()
public ExecuteSqlRequest.QueryOptions buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions | |
clear()
public ExecuteSqlRequest.QueryOptions.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ExecuteSqlRequest.QueryOptions.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecuteSqlRequest.QueryOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
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:
`
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.
string optimizer_statistics_package = 2;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
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;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
clone()
public ExecuteSqlRequest.QueryOptions.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
getDefaultInstanceForType()
public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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:
`
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.
string optimizer_statistics_package = 2;
| Returns | |
|---|---|
| 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:
`
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.
string optimizer_statistics_package = 2;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for optimizerVersion. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
mergeFrom(ExecuteSqlRequest.QueryOptions other)
public ExecuteSqlRequest.QueryOptions.Builder mergeFrom(ExecuteSqlRequest.QueryOptions other)| Parameter | |
|---|---|
| Name | Description |
other | ExecuteSqlRequest.QueryOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.QueryOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.QueryOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
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:
`
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.
string optimizer_statistics_package = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe optimizerStatisticsPackage to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
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:
`
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.
string optimizer_statistics_package = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for optimizerStatisticsPackage to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe optimizerVersion to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for optimizerVersion to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecuteSqlRequest.QueryOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.QueryOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |