Package com.google.spanner.v1

Class ExecuteSqlRequest.QueryOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.ExecuteSqlRequest.QueryOptions

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteSqlRequest.QueryOptionsOrBuilder, Serializable

Enclosing class:

ExecuteSqlRequest

public static final class ExecuteSqlRequest.QueryOptions
extends com.google.protobuf.GeneratedMessageV3
implements ExecuteSqlRequest.QueryOptionsOrBuilder

 Query optimizer configuration.
 

Protobuf type google.spanner.v1.ExecuteSqlRequest.QueryOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecuteSqlRequest.QueryOptions.Builder	Query optimizer configuration.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER
static int	OPTIMIZER_VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ExecuteSqlRequest.QueryOptions	getDefaultInstance()
ExecuteSqlRequest.QueryOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getOptimizerStatisticsPackage()	An option to control the selection of optimizer statistics package.
com.google.protobuf.ByteString	getOptimizerStatisticsPackageBytes()	An option to control the selection of optimizer statistics package.
String	getOptimizerVersion()	An option to control the selection of optimizer version.
com.google.protobuf.ByteString	getOptimizerVersionBytes()	An option to control the selection of optimizer version.
com.google.protobuf.Parser<ExecuteSqlRequest.QueryOptions>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExecuteSqlRequest.QueryOptions.Builder	newBuilder()
static ExecuteSqlRequest.QueryOptions.Builder	newBuilder(ExecuteSqlRequest.QueryOptions prototype)
ExecuteSqlRequest.QueryOptions.Builder	newBuilderForType()
protected ExecuteSqlRequest.QueryOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExecuteSqlRequest.QueryOptions	parseDelimitedFrom(InputStream input)
static ExecuteSqlRequest.QueryOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest.QueryOptions	parseFrom(byte[] data)
static ExecuteSqlRequest.QueryOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest.QueryOptions	parseFrom(com.google.protobuf.ByteString data)
static ExecuteSqlRequest.QueryOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest.QueryOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static ExecuteSqlRequest.QueryOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest.QueryOptions	parseFrom(InputStream input)
static ExecuteSqlRequest.QueryOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest.QueryOptions	parseFrom(ByteBuffer data)
static ExecuteSqlRequest.QueryOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExecuteSqlRequest.QueryOptions>	parser()
ExecuteSqlRequest.QueryOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

OPTIMIZER_VERSION_FIELD_NUMBER

public static final int OPTIMIZER_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER

public static final int OPTIMIZER_STATISTICS_PACKAGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getOptimizerVersion in interface ExecuteSqlRequest.QueryOptionsOrBuilder

Returns:

The optimizerVersion.

getOptimizerVersionBytes

public com.google.protobuf.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;

Specified by:

getOptimizerVersionBytes in interface ExecuteSqlRequest.QueryOptionsOrBuilder

Returns:

The bytes for optimizerVersion.

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;

Specified by:

getOptimizerStatisticsPackage in interface ExecuteSqlRequest.QueryOptionsOrBuilder

Returns:

The optimizerStatisticsPackage.

getOptimizerStatisticsPackageBytes

public com.google.protobuf.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;

Specified by:

getOptimizerStatisticsPackageBytes in interface ExecuteSqlRequest.QueryOptionsOrBuilder

Returns:

The bytes for optimizerStatisticsPackage.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ExecuteSqlRequest.QueryOptions parseDelimitedFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ExecuteSqlRequest.QueryOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public ExecuteSqlRequest.QueryOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExecuteSqlRequest.QueryOptions.Builder newBuilder()

newBuilder

public static ExecuteSqlRequest.QueryOptions.Builder newBuilder(ExecuteSqlRequest.QueryOptions prototype)

toBuilder

public ExecuteSqlRequest.QueryOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExecuteSqlRequest.QueryOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExecuteSqlRequest.QueryOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<ExecuteSqlRequest.QueryOptions> parser()

getParserForType

public com.google.protobuf.Parser<ExecuteSqlRequest.QueryOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder