Method: projects.instances.databases.sessions.executeSql

Executes an SQL query, returning all rows in a single reply. This method cannot 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.

Queries 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 sessions.executeStreamingSql instead.

HTTP request

POST https://spanner.googleapis.com/v1/{session=projects/*/instances/*/databases/*/sessions/*}:executeSql

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
session

string

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

Authorization requires the following Google IAM permission on the specified resource session:

  • spanner.databases.select

Request body

The request body contains data with the following structure:

JSON representation
{
  "transaction": {
    object(TransactionSelector)
  },
  "sql": string,
  "params": {
    object
  },
  "paramTypes": {
    string: {
      object(Type)
    },
    ...
  },
  "resumeToken": string,
  "queryMode": enum(QueryMode),
}
Fields
transaction

object(TransactionSelector)

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

sql

string

Required. The SQL query string.

params

object (Struct format)

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.

paramTypes

map (key: string, value: object(Type))

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 as JSON strings.

In these cases, paramTypes can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resumeToken

string (bytes format)

If this request is resuming a previously interrupted SQL query execution, resumeToken should be copied from the last 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.

A base64-encoded string.

queryMode

enum(QueryMode)

Used to control the amount of debugging information returned in ResultSetStats.

Response body

If successful, the response body contains an instance of ResultSet.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/spanner.data
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Try it!

Send feedback about...

Cloud Spanner Documentation