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

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

Arguments

Parameters
session	string Required. The session in which the read should be performed.
body	object (ReadRequest) 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

- streamingRead:
    call: googleapis.spanner.v1.projects.instances.databases.sessions.streamingRead
    args:
        session: ...
        body:
            columns: ...
            index: ...
            keySet:
                all: ...
                keys: ...
                ranges: ...
            limit: ...
            partitionToken: ...
            requestOptions:
                priority: ...
                requestTag: ...
                transactionTag: ...
            resumeToken: ...
            table: ...
            transaction:
                begin:
                    partitionedDml: ...
                    readOnly:
                        exactStaleness: ...
                        maxStaleness: ...
                        minReadTimestamp: ...
                        readTimestamp: ...
                        returnReadTimestamp: ...
                        strong: ...
                    readWrite:
                        readLockMode: ...
                id: ...
                singleUse: ...
    result: streamingReadResult

JSON

[
  {
    "streamingRead": {
      "call": "googleapis.spanner.v1.projects.instances.databases.sessions.streamingRead",
      "args": {
        "session": "...",
        "body": {
          "columns": "...",
          "index": "...",
          "keySet": {
            "all": "...",
            "keys": "...",
            "ranges": "..."
          },
          "limit": "...",
          "partitionToken": "...",
          "requestOptions": {
            "priority": "...",
            "requestTag": "...",
            "transactionTag": "..."
          },
          "resumeToken": "...",
          "table": "...",
          "transaction": {
            "begin": {
              "partitionedDml": "...",
              "readOnly": {
                "exactStaleness": "...",
                "maxStaleness": "...",
                "minReadTimestamp": "...",
                "readTimestamp": "...",
                "returnReadTimestamp": "...",
                "strong": "..."
              },
              "readWrite": {
                "readLockMode": "..."
              }
            },
            "id": "...",
            "singleUse": "..."
          }
        }
      },
      "result": "streamingReadResult"
    }
  }
]