Class ExecuteSqlRequest.QueryOptions (6.25.1)

Stay organized with collections Save and categorize content based on your preferences.
public static final class ExecuteSqlRequest.QueryOptions extends GeneratedMessageV3 implements ExecuteSqlRequest.QueryOptionsOrBuilder

Query optimizer configuration.

Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExecuteSqlRequest.QueryOptions

Static Fields

OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER

public static final int OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIMIZER_VERSION_FIELD_NUMBER

public static final int OPTIMIZER_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExecuteSqlRequest.QueryOptions getDefaultInstance()
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExecuteSqlRequest.QueryOptions.Builder newBuilder()
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions.Builder

newBuilder(ExecuteSqlRequest.QueryOptions prototype)

public static ExecuteSqlRequest.QueryOptions.Builder newBuilder(ExecuteSqlRequest.QueryOptions prototype)
Parameter
NameDescription
prototypeExecuteSqlRequest.QueryOptions
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteSqlRequest.QueryOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExecuteSqlRequest.QueryOptions> parser()
Returns
TypeDescription
Parser<QueryOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions

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 &lt;package_name&gt; 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
TypeDescription
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 &lt;package_name&gt; 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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for optimizerVersion.

getParserForType()

public Parser<ExecuteSqlRequest.QueryOptions> getParserForType()
Returns
TypeDescription
Parser<QueryOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExecuteSqlRequest.QueryOptions.Builder newBuilderForType()
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteSqlRequest.QueryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExecuteSqlRequest.QueryOptions.Builder toBuilder()
Returns
TypeDescription
ExecuteSqlRequest.QueryOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException