public static final class ExecuteSqlRequest.QueryOptions extends GeneratedMessageV3 implements ExecuteSqlRequest.QueryOptionsOrBuilder
Query optimizer configuration.
Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryOptions
Static Fields
OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER
public static final int OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER
Field Value
OPTIMIZER_VERSION_FIELD_NUMBER
public static final int OPTIMIZER_VERSION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ExecuteSqlRequest.QueryOptions getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ExecuteSqlRequest.QueryOptions.Builder newBuilder()
Returns
newBuilder(ExecuteSqlRequest.QueryOptions prototype)
public static ExecuteSqlRequest.QueryOptions.Builder newBuilder(ExecuteSqlRequest.QueryOptions prototype)
Parameter
Returns
public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ExecuteSqlRequest.QueryOptions parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest.QueryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecuteSqlRequest.QueryOptions parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest.QueryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ExecuteSqlRequest.QueryOptions> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()
Returns
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;
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:
<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;
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.
|
getParserForType()
public Parser<ExecuteSqlRequest.QueryOptions> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ExecuteSqlRequest.QueryOptions.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecuteSqlRequest.QueryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ExecuteSqlRequest.QueryOptions.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions