ExecuteSqlRequest (Cloud Spanner API v1-rev20250708-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.spanner.v1.model.ExecuteSqlRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class ExecuteSqlRequest
extends com.google.api.client.json.GenericJson
```
The request for ExecuteSql and ExecuteStreamingSql.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ExecuteSqlRequest()

Constructors
Constructor and Description
`ExecuteSqlRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExecuteSqlRequest`	`clone()`
`byte[]`	`decodePartitionToken()` If present, results are restricted to the specified partition previously created using `PartitionQuery`.
`byte[]`	`decodeResumeToken()` If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
`ExecuteSqlRequest`	`encodePartitionToken(byte[] partitionToken)` If present, results are restricted to the specified partition previously created using `PartitionQuery`.
`ExecuteSqlRequest`	`encodeResumeToken(byte[] resumeToken)` If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
`Boolean`	`getDataBoostEnabled()` If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources.
`DirectedReadOptions`	`getDirectedReadOptions()` Directed read options for this request.
`Boolean`	`getLastStatement()` Optional.
`Map<String,Object>`	`getParams()` Parameter names and values that bind to placeholders in the SQL string.
`Map<String,Type>`	`getParamTypes()` It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value.
`String`	`getPartitionToken()` If present, results are restricted to the specified partition previously created using `PartitionQuery`.
`String`	`getQueryMode()` Used to control the amount of debugging information returned in ResultSetStats.
`QueryOptions`	`getQueryOptions()` Query optimizer configuration to use for the given query.
`RequestOptions`	`getRequestOptions()` Common options for this request.
`String`	`getResumeToken()` If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
`Long`	`getSeqno()` A per-transaction sequence number used to identify this request.
`String`	`getSql()` Required.
`TransactionSelector`	`getTransaction()` The transaction to use.
`ExecuteSqlRequest`	`set(String fieldName, Object value)`
`ExecuteSqlRequest`	`setDataBoostEnabled(Boolean dataBoostEnabled)` If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources.
`ExecuteSqlRequest`	`setDirectedReadOptions(DirectedReadOptions directedReadOptions)` Directed read options for this request.
`ExecuteSqlRequest`	`setLastStatement(Boolean lastStatement)` Optional.
`ExecuteSqlRequest`	`setParams(Map<String,Object> params)` Parameter names and values that bind to placeholders in the SQL string.
`ExecuteSqlRequest`	`setParamTypes(Map<String,Type> paramTypes)` It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value.
`ExecuteSqlRequest`	`setPartitionToken(String partitionToken)` If present, results are restricted to the specified partition previously created using `PartitionQuery`.
`ExecuteSqlRequest`	`setQueryMode(String queryMode)` Used to control the amount of debugging information returned in ResultSetStats.
`ExecuteSqlRequest`	`setQueryOptions(QueryOptions queryOptions)` Query optimizer configuration to use for the given query.
`ExecuteSqlRequest`	`setRequestOptions(RequestOptions requestOptions)` Common options for this request.
`ExecuteSqlRequest`	`setResumeToken(String resumeToken)` If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
`ExecuteSqlRequest`	`setSeqno(Long seqno)` A per-transaction sequence number used to identify this request.
`ExecuteSqlRequest`	`setSql(String sql)` Required.
`ExecuteSqlRequest`	`setTransaction(TransactionSelector transaction)` The transaction to use.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ExecuteSqlRequest
```
public ExecuteSqlRequest()
```
- Method Detail
  - getDataBoostEnabled
```
public Boolean getDataBoostEnabled()
```
    If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.
    
    Returns:
    
    value or null for none
  - setDataBoostEnabled
```
public ExecuteSqlRequest setDataBoostEnabled(Boolean dataBoostEnabled)
```
    If this is for a partitioned query and this field is set to `true`, the request is executed with Spanner Data Boost independent compute resources. If the field is set to `true` but the request doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.
    
    Parameters:
    
    dataBoostEnabled - dataBoostEnabled or null for none
  - getDirectedReadOptions
```
public DirectedReadOptions getDirectedReadOptions()
```
    Directed read options for this request.
    
    Returns:
    
    value or null for none
  - setDirectedReadOptions
```
public ExecuteSqlRequest setDirectedReadOptions(DirectedReadOptions directedReadOptions)
```
    Directed read options for this request.
    
    Parameters:
    
    directedReadOptions - directedReadOptions or null for none
  - getLastStatement
```
public Boolean getLastStatement()
```
    Optional. If set to `true`, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent `Commit` call completes successfully.
    
    Returns:
    
    value or null for none
  - setLastStatement
```
public ExecuteSqlRequest setLastStatement(Boolean lastStatement)
```
    Optional. If set to `true`, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent `Commit` call completes successfully.
    
    Parameters:
    
    lastStatement - lastStatement or null for none
  - getParamTypes
```
public Map<String,Type> getParamTypes()
```
    It isn't 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 as JSON strings. In these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
    
    Returns:
    
    value or null for none
  - setParamTypes
```
public ExecuteSqlRequest setParamTypes(Map<String,Type> paramTypes)
```
    It isn't 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 as JSON strings. In these cases, you can use `param_types` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
    
    Parameters:
    
    paramTypes - paramTypes or null for none
  - getParams
```
public Map<String,Object> getParams()
```
    Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. 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's an error to execute a SQL statement with unbound parameters.
    
    Returns:
    
    value or null for none
  - setParams
```
public ExecuteSqlRequest setParams(Map<String,Object> params)
```
    Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. 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's an error to execute a SQL statement with unbound parameters.
    
    Parameters:
    
    params - params or null for none
  - getPartitionToken
```
public String getPartitionToken()
```
    If present, results are 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`.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodePartitionToken()
  - decodePartitionToken
```
public byte[] decodePartitionToken()
```
    If present, results are 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`.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getPartitionToken()
  - setPartitionToken
```
public ExecuteSqlRequest setPartitionToken(String partitionToken)
```
    If present, results are 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`.
    
    Parameters:
    
    partitionToken - partitionToken or null for none
    
    See Also:
    
    #encodePartitionToken()
  - encodePartitionToken
```
public ExecuteSqlRequest encodePartitionToken(byte[] partitionToken)
```
    If present, results are 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`.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getQueryMode
```
public String getQueryMode()
```
    Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
    
    Returns:
    
    value or null for none
  - setQueryMode
```
public ExecuteSqlRequest setQueryMode(String queryMode)
```
    Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
    
    Parameters:
    
    queryMode - queryMode or null for none
  - getQueryOptions
```
public QueryOptions getQueryOptions()
```
    Query optimizer configuration to use for the given query.
    
    Returns:
    
    value or null for none
  - setQueryOptions
```
public ExecuteSqlRequest setQueryOptions(QueryOptions queryOptions)
```
    Query optimizer configuration to use for the given query.
    
    Parameters:
    
    queryOptions - queryOptions or null for none
  - getRequestOptions
```
public RequestOptions getRequestOptions()
```
    Common options for this request.
    
    Returns:
    
    value or null for none
  - setRequestOptions
```
public ExecuteSqlRequest setRequestOptions(RequestOptions requestOptions)
```
    Common options for this request.
    
    Parameters:
    
    requestOptions - requestOptions or null for none
  - getResumeToken
```
public String getResumeToken()
```
    If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeResumeToken()
  - decodeResumeToken
```
public byte[] decodeResumeToken()
```
    If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getResumeToken()
  - setResumeToken
```
public ExecuteSqlRequest setResumeToken(String resumeToken)
```
    If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
    
    Parameters:
    
    resumeToken - resumeToken or null for none
    
    See Also:
    
    #encodeResumeToken()
  - encodeResumeToken
```
public ExecuteSqlRequest encodeResumeToken(byte[] resumeToken)
```
    If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getSeqno
```
public Long getSeqno()
```
    A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries.
    
    Returns:
    
    value or null for none
  - setSeqno
```
public ExecuteSqlRequest setSeqno(Long seqno)
```
    A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries.
    
    Parameters:
    
    seqno - seqno or null for none
  - getSql
```
public String getSql()
```
    Required. The SQL string.
    
    Returns:
    
    value or null for none
  - setSql
```
public ExecuteSqlRequest setSql(String sql)
```
    Required. The SQL string.
    
    Parameters:
    
    sql - sql or null for none
  - getTransaction
```
public TransactionSelector getTransaction()
```
    The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID.
    
    Returns:
    
    value or null for none
  - setTransaction
```
public ExecuteSqlRequest setTransaction(TransactionSelector transaction)
```
    The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID.
    
    Parameters:
    
    transaction - transaction or null for none
  - set
```
public ExecuteSqlRequest set(String fieldName,
                             Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ExecuteSqlRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class ExecuteSqlRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ExecuteSqlRequest

Method Detail

getDataBoostEnabled

setDataBoostEnabled

getDirectedReadOptions

setDirectedReadOptions

getLastStatement

setLastStatement

getParamTypes

setParamTypes

getParams

setParams

getPartitionToken

decodePartitionToken

setPartitionToken

encodePartitionToken

getQueryMode

setQueryMode

getQueryOptions

setQueryOptions

getRequestOptions

setRequestOptions

getResumeToken

decodeResumeToken

setResumeToken

encodeResumeToken

getSeqno

setSeqno

getSql

setSql

getTransaction

setTransaction

set

clone