Class ExecuteSqlRequest.QueryOptions.Builder (6.25.0)

Version 6.25.0

• 6.82.0 (latest)
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

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

Inheritance

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

Implements

ExecuteSqlRequest.QueryOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ExecuteSqlRequest.QueryOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ExecuteSqlRequest.QueryOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteSqlRequest.QueryOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ExecuteSqlRequest.QueryOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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 &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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ExecuteSqlRequest.QueryOptions getDefaultInstanceForType()

Returns

Type	Description
ExecuteSqlRequest.QueryOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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 &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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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 &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;

Parameter

Name	Description
value	String The 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: <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;

Parameter

Name	Description
value	ByteString The 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	String The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteSqlRequest.QueryOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ExecuteSqlRequest.QueryOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)