com.google.spanner.v1

Class ExecuteSqlRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.ExecuteSqlRequest

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ExecuteSqlRequestOrBuilder, java.io.Serializable

public final class ExecuteSqlRequest
extends GeneratedMessageV3
implements ExecuteSqlRequestOrBuilder

 The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
 [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
 

Protobuf type google.spanner.v1.ExecuteSqlRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecuteSqlRequest.Builder The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
static class	ExecuteSqlRequest.QueryMode Mode in which the query must be processed.

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

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAM_TYPES_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER
static int	PARTITION_TOKEN_FIELD_NUMBER
static int	QUERY_MODE_FIELD_NUMBER
static int	RESUME_TOKEN_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER
static int	SQL_FIELD_NUMBER
static int	TRANSACTION_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 and Description
boolean	containsParamTypes(java.lang.String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
boolean	equals(java.lang.Object obj)
static ExecuteSqlRequest	getDefaultInstance()
ExecuteSqlRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Struct	getParams() The SQL query string can contain parameter placeholders.
StructOrBuilder	getParamsOrBuilder() The SQL query string can contain parameter placeholders.
java.util.Map<java.lang.String,Type>	getParamTypes() Deprecated.
int	getParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
java.util.Map<java.lang.String,Type>	getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrDefault(java.lang.String key, Type defaultValue) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrThrow(java.lang.String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Parser<ExecuteSqlRequest>	getParserForType()
ByteString	getPartitionToken() If present, results will be restricted to the specified partition previously created using PartitionQuery().
ExecuteSqlRequest.QueryMode	getQueryMode() Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
int	getQueryModeValue() Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
ByteString	getResumeToken() If this request is resuming a previously interrupted SQL query execution, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
int	getSerializedSize()
java.lang.String	getSession() Required.
ByteString	getSessionBytes() Required.
java.lang.String	getSql() Required.
ByteString	getSqlBytes() Required.
TransactionSelector	getTransaction() The transaction to use.
TransactionSelectorOrBuilder	getTransactionOrBuilder() The transaction to use.
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasParams() The SQL query string can contain parameter placeholders.
boolean	hasTransaction() The transaction to use.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static ExecuteSqlRequest.Builder	newBuilder()
static ExecuteSqlRequest.Builder	newBuilder(ExecuteSqlRequest prototype)
ExecuteSqlRequest.Builder	newBuilderForType()
protected ExecuteSqlRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static ExecuteSqlRequest	parseDelimitedFrom(java.io.InputStream input)
static ExecuteSqlRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest	parseFrom(byte[] data)
static ExecuteSqlRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest	parseFrom(java.nio.ByteBuffer data)
static ExecuteSqlRequest	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest	parseFrom(ByteString data)
static ExecuteSqlRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest	parseFrom(CodedInputStream input)
static ExecuteSqlRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ExecuteSqlRequest	parseFrom(java.io.InputStream input)
static ExecuteSqlRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ExecuteSqlRequest>	parser()
ExecuteSqlRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

SQL_FIELD_NUMBER

public static final int SQL_FIELD_NUMBER

See Also:

Constant Field Values

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

PARAM_TYPES_FIELD_NUMBER

public static final int PARAM_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_MODE_FIELD_NUMBER

public static final int QUERY_MODE_FIELD_NUMBER

See Also:

Constant Field Values

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getSession

public java.lang.String getSession()

 Required. The session in which the SQL query should be performed.
 

string session = 1;

Specified by:

getSession in interface ExecuteSqlRequestOrBuilder

getSessionBytes

public ByteString getSessionBytes()

 Required. The session in which the SQL query should be performed.
 

string session = 1;

Specified by:

getSessionBytes in interface ExecuteSqlRequestOrBuilder

hasTransaction

public boolean hasTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

hasTransaction in interface ExecuteSqlRequestOrBuilder

getTransaction

public TransactionSelector getTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

getTransaction in interface ExecuteSqlRequestOrBuilder

getTransactionOrBuilder

public TransactionSelectorOrBuilder getTransactionOrBuilder()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 

.google.spanner.v1.TransactionSelector transaction = 2;

Specified by:

getTransactionOrBuilder in interface ExecuteSqlRequestOrBuilder

getSql

public java.lang.String getSql()

 Required. The SQL query string.
 

string sql = 3;

Specified by:

getSql in interface ExecuteSqlRequestOrBuilder

getSqlBytes

public ByteString getSqlBytes()

 Required. The SQL query string.
 

string sql = 3;

Specified by:

getSqlBytes in interface ExecuteSqlRequestOrBuilder

hasParams

public boolean hasParams()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

hasParams in interface ExecuteSqlRequestOrBuilder

getParams

public Struct getParams()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

getParams in interface ExecuteSqlRequestOrBuilder

getParamsOrBuilder

public StructOrBuilder getParamsOrBuilder()

 The SQL query string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 Parameters can appear anywhere that a literal value is expected.  The same
 parameter name can be used more than once, for example:
   `"WHERE id > @msg_id AND id < @msg_id + 100"`
 It is an error to execute an SQL query with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

Specified by:

getParamsOrBuilder in interface ExecuteSqlRequestOrBuilder

getParamTypesCount

public int getParamTypesCount()

Description copied from interface: ExecuteSqlRequestOrBuilder

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesCount in interface ExecuteSqlRequestOrBuilder

containsParamTypes

public boolean containsParamTypes(java.lang.String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

containsParamTypes in interface ExecuteSqlRequestOrBuilder

getParamTypes

@Deprecated
public java.util.Map<java.lang.String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

Specified by:

getParamTypes in interface ExecuteSqlRequestOrBuilder

getParamTypesMap

public java.util.Map<java.lang.String,Type> getParamTypesMap()

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesMap in interface ExecuteSqlRequestOrBuilder

getParamTypesOrDefault

public Type getParamTypesOrDefault(java.lang.String key,
                                   Type defaultValue)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesOrDefault in interface ExecuteSqlRequestOrBuilder

getParamTypesOrThrow

public Type getParamTypesOrThrow(java.lang.String key)

 It is not always possible for Cloud Spanner to infer the right SQL type
 from a JSON value.  For example, values of type `BYTES` and values
 of type `STRING` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings.
 In these cases, `param_types` can be used to specify the exact
 SQL type for some or all of the SQL query parameters. See the
 definition of [Type][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

Specified by:

getParamTypesOrThrow in interface ExecuteSqlRequestOrBuilder

getResumeToken

public ByteString getResumeToken()

 If this request is resuming a previously interrupted SQL query
 execution, `resume_token` should be copied from the last
 [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this
 enables the new SQL query execution to resume where the last one left
 off. The rest of the request parameters must exactly match the
 request that yielded this token.
 

bytes resume_token = 6;

Specified by:

getResumeToken in interface ExecuteSqlRequestOrBuilder

getQueryModeValue

public int getQueryModeValue()

 Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
 

.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;

Specified by:

getQueryModeValue in interface ExecuteSqlRequestOrBuilder

getQueryMode

public ExecuteSqlRequest.QueryMode getQueryMode()

 Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
 

.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;

Specified by:

getQueryMode in interface ExecuteSqlRequestOrBuilder

getPartitionToken

public ByteString getPartitionToken()

 If present, results will be restricted to the specified partition
 previously created using PartitionQuery().  There must be an exact
 match for the values of fields common to this message and the
 PartitionQueryRequest message used to create this partition_token.
 

bytes partition_token = 8;

Specified by:

getPartitionToken in interface ExecuteSqlRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ExecuteSqlRequest parseFrom(java.nio.ByteBuffer data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(java.nio.ByteBuffer data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(ByteString data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(ByteString data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(byte[] data)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(byte[] data,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ExecuteSqlRequest parseFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ExecuteSqlRequest parseFrom(java.io.InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ExecuteSqlRequest parseDelimitedFrom(java.io.InputStream input)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ExecuteSqlRequest parseDelimitedFrom(java.io.InputStream input,
                                                   ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ExecuteSqlRequest parseFrom(CodedInputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ExecuteSqlRequest parseFrom(CodedInputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public ExecuteSqlRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ExecuteSqlRequest.Builder newBuilder()

newBuilder

public static ExecuteSqlRequest.Builder newBuilder(ExecuteSqlRequest prototype)

toBuilder

public ExecuteSqlRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ExecuteSqlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ExecuteSqlRequest getDefaultInstance()

parser

public static Parser<ExecuteSqlRequest> parser()

getParserForType

public Parser<ExecuteSqlRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ExecuteSqlRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder