Method: projects.instances.databases.sessions.executeStreamingSql

Like sessions.executeSql, except returns the result set as a stream. Unlike sessions.executeSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

HTTP request

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

The URL uses gRPC Transcoding 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),
  "partitionToken": string,
  "seqno": string
}
Fields
transaction

object(TransactionSelector)

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

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 ReadWrite transaction. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing PartitionedDml transaction ID.

sql

string

Required. The SQL string.

params

object (Struct format)

The SQL 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 statement 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 statement 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 statement execution, resumeToken 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.

A base64-encoded string.

queryMode

enum(QueryMode)

Used to control the amount of debugging information returned in ResultSetStats. If partitionToken is set, queryMode can only be set to QueryMode.NORMAL.

partitionToken

string (bytes format)

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

A base64-encoded string.

seqno

string (int64 format)

A per-transaction sequence number used to identify this request. This makes each request idempotent such that if the request is received multiple times, at most one will succeed.

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 may be aborted. Replays of previously handled requests will yield the same response as the first execution.

Required for DML statements. Ignored for queries.

Response body

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

Authorization Scopes

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 Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Spanner Documentation