Send feedback
Method: googleapis.spanner.v1.projects.instances.databases.sessions.executeSql
Stay organized with collections
Save and categorize content based on your preferences.
Executes an SQL statement, returning all results in a single reply. This
method can't be used to return a result set larger than 10 MiB; if the
query yields more data than that, the query fails with a
FAILED_PRECONDITION
error. Operations inside read-write transactions
might return ABORTED
. If this occurs, the application should restart
the transaction from the beginning. See Transaction for more details.
Larger result sets can be fetched in streaming fashion by calling
ExecuteStreamingSql instead. The query string can be SQL or Graph Query
Language
(GQL) .
For more information about retries and long-running operations, see
Understand connectors .
Arguments
Parameters
session
string
Required. The session in which the SQL query should be performed.
body
object (ExecuteSqlRequest )
Required.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of ResultSet
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation .
YAML
- executeSql :
call : googleapis.spanner.v1.projects.instances.databases.sessions.executeSql
args :
session : ...
body :
dataBoostEnabled : ...
directedReadOptions :
excludeReplicas :
replicaSelections : ...
includeReplicas :
autoFailoverDisabled : ...
replicaSelections : ...
lastStatement : ...
paramTypes : ...
params : ...
partitionToken : ...
queryMode : ...
queryOptions :
optimizerStatisticsPackage : ...
optimizerVersion : ...
requestOptions :
priority : ...
requestTag : ...
transactionTag : ...
resumeToken : ...
seqno : ...
sql : ...
transaction :
begin :
excludeTxnFromChangeStreams : ...
isolationLevel : ...
partitionedDml : ...
readOnly :
exactStaleness : ...
maxStaleness : ...
minReadTimestamp : ...
readTimestamp : ...
returnReadTimestamp : ...
strong : ...
readWrite :
multiplexedSessionPreviousTransactionId : ...
readLockMode : ...
id : ...
singleUse : ...
result : executeSqlResult
JSON
[
{
"executeSql" : {
"call" : "googleapis.spanner.v1.projects.instances.databases.sessions.executeSql" ,
"args" : {
"session" : "..." ,
"body" : {
"dataBoostEnabled" : "..." ,
"directedReadOptions" : {
"excludeReplicas" : {
"replicaSelections" : "..."
},
"includeReplicas" : {
"autoFailoverDisabled" : "..." ,
"replicaSelections" : "..."
}
},
"lastStatement" : "..." ,
"paramTypes" : "..." ,
"params" : "..." ,
"partitionToken" : "..." ,
"queryMode" : "..." ,
"queryOptions" : {
"optimizerStatisticsPackage" : "..." ,
"optimizerVersion" : "..."
},
"requestOptions" : {
"priority" : "..." ,
"requestTag" : "..." ,
"transactionTag" : "..."
},
"resumeToken" : "..." ,
"seqno" : "..." ,
"sql" : "..." ,
"transaction" : {
"begin" : {
"excludeTxnFromChangeStreams" : "..." ,
"isolationLevel" : "..." ,
"partitionedDml" : "..." ,
"readOnly" : {
"exactStaleness" : "..." ,
"maxStaleness" : "..." ,
"minReadTimestamp" : "..." ,
"readTimestamp" : "..." ,
"returnReadTimestamp" : "..." ,
"strong" : "..."
},
"readWrite" : {
"multiplexedSessionPreviousTransactionId" : "..." ,
"readLockMode" : "..."
}
},
"id" : "..." ,
"singleUse" : "..."
}
}
},
"result" : "executeSqlResult"
}
}
]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Method: googleapis.spanner.v1.projects.instances.databases.sessions.executeSql\n\nExecutes an SQL statement, returning all results in a single reply. This\nmethod can't be used to return a result set larger than 10 MiB; if the\nquery yields more data than that, the query fails with a\n`FAILED_PRECONDITION` error. Operations inside read-write transactions\nmight return `ABORTED`. If this occurs, the application should restart\nthe transaction from the beginning. See Transaction for more details.\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead. The query string can be SQL or [Graph Query\nLanguage\n(GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro).\n\nFor more information about retries and long-running operations, see\n[Understand connectors]().\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`ResultSet`](https://cloud.google.com/workflows/docs/reference/googleapis/spanner/v1/Overview#ResultSet).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instances.databases.sessions/executeSql). \n\n### YAML\n\n```yaml\n- executeSql:\n call: googleapis.spanner.v1.projects.instances.databases.sessions.executeSql\n args:\n session: ...\n body:\n dataBoostEnabled: ...\n directedReadOptions:\n excludeReplicas:\n replicaSelections: ...\n includeReplicas:\n autoFailoverDisabled: ...\n replicaSelections: ...\n lastStatement: ...\n paramTypes: ...\n params: ...\n partitionToken: ...\n queryMode: ...\n queryOptions:\n optimizerStatisticsPackage: ...\n optimizerVersion: ...\n requestOptions:\n priority: ...\n requestTag: ...\n transactionTag: ...\n resumeToken: ...\n seqno: ...\n sql: ...\n transaction:\n begin:\n excludeTxnFromChangeStreams: ...\n isolationLevel: ...\n partitionedDml: ...\n readOnly:\n exactStaleness: ...\n maxStaleness: ...\n minReadTimestamp: ...\n readTimestamp: ...\n returnReadTimestamp: ...\n strong: ...\n readWrite:\n multiplexedSessionPreviousTransactionId: ...\n readLockMode: ...\n id: ...\n singleUse: ...\n result: executeSqlResult\n```\n\n### JSON\n\n```json\n[\n {\n \"executeSql\": {\n \"call\": \"googleapis.spanner.v1.projects.instances.databases.sessions.executeSql\",\n \"args\": {\n \"session\": \"...\",\n \"body\": {\n \"dataBoostEnabled\": \"...\",\n \"directedReadOptions\": {\n \"excludeReplicas\": {\n \"replicaSelections\": \"...\"\n },\n \"includeReplicas\": {\n \"autoFailoverDisabled\": \"...\",\n \"replicaSelections\": \"...\"\n }\n },\n \"lastStatement\": \"...\",\n \"paramTypes\": \"...\",\n \"params\": \"...\",\n \"partitionToken\": \"...\",\n \"queryMode\": \"...\",\n \"queryOptions\": {\n \"optimizerStatisticsPackage\": \"...\",\n \"optimizerVersion\": \"...\"\n },\n \"requestOptions\": {\n \"priority\": \"...\",\n \"requestTag\": \"...\",\n \"transactionTag\": \"...\"\n },\n \"resumeToken\": \"...\",\n \"seqno\": \"...\",\n \"sql\": \"...\",\n \"transaction\": {\n \"begin\": {\n \"excludeTxnFromChangeStreams\": \"...\",\n \"isolationLevel\": \"...\",\n \"partitionedDml\": \"...\",\n \"readOnly\": {\n \"exactStaleness\": \"...\",\n \"maxStaleness\": \"...\",\n \"minReadTimestamp\": \"...\",\n \"readTimestamp\": \"...\",\n \"returnReadTimestamp\": \"...\",\n \"strong\": \"...\"\n },\n \"readWrite\": {\n \"multiplexedSessionPreviousTransactionId\": \"...\",\n \"readLockMode\": \"...\"\n }\n },\n \"id\": \"...\",\n \"singleUse\": \"...\"\n }\n }\n },\n \"result\": \"executeSqlResult\"\n }\n }\n]\n```"]]