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

Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
database

string

Required. The database in which the new sessions are created.

body

object (BatchCreateSessionsRequest)

Required.

Raised exceptions

Exceptions
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf 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 BatchCreateSessionsResponse.

Subworkflow snippet

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

YAML

- batchCreate:
    call: googleapis.spanner.v1.projects.instances.databases.sessions.batchCreate
    args:
        database: ...
        body:
            sessionCount: ...
            sessionTemplate:
                creatorRole: ...
                labels: ...
                multiplexed: ...
    result: batchCreateResult

JSON

[
  {
    "batchCreate": {
      "call": "googleapis.spanner.v1.projects.instances.databases.sessions.batchCreate",
      "args": {
        "database": "...",
        "body": {
          "sessionCount": "...",
          "sessionTemplate": {
            "creatorRole": "...",
            "labels": "...",
            "multiplexed": "..."
          }
        }
      },
      "result": "batchCreateResult"
    }
  }
]