Method: googleapis.spanner.v1.projects.instances.databases.sessions.executeStreamingSql

Like ExecuteSql, except returns the result set as a stream. Unlike 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. 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 PartialResultSet.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- executeStreamingSql:
    call: googleapis.spanner.v1.projects.instances.databases.sessions.executeStreamingSql
    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: executeStreamingSqlResult

JSON

[
  {
    "executeStreamingSql": {
      "call": "googleapis.spanner.v1.projects.instances.databases.sessions.executeStreamingSql",
      "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": "executeStreamingSqlResult"
    }
  }
]