As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Spanner

class google.cloud.spanner_v1.services.spanner.SpannerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Cloud Spanner API The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

Instantiates the spanner client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, SpannerTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async batch_create_sessions(request: Optional[Union[google.cloud.spanner_v1.types.spanner.BatchCreateSessionsRequest, dict]] = None, *, database: Optional[str] = None, session_count: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.BatchCreateSessionsResponse[source]

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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.BatchCreateSessionsRequest, dict]) – The request object. The request for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions].

  • database (str) –

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

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • session_count (int) –

    Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting [session_count][google.spanner.v1.BatchCreateSessionsRequest.session_count] as necessary).

    This corresponds to the session_count field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions].

Return type

google.cloud.spanner_v1.types.BatchCreateSessionsResponse

async begin_transaction(request: Optional[Union[google.cloud.spanner_v1.types.spanner.BeginTransactionRequest, dict]] = None, *, session: Optional[str] = None, options: Optional[google.cloud.spanner_v1.types.transaction.TransactionOptions] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.transaction.Transaction[source]

Begins a new transaction. This step can often be skipped: [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.

Parameters
  • request (Union[google.cloud.spanner_v1.types.BeginTransactionRequest, dict]) – The request object. The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].

  • session (str) –

    Required. The session in which the transaction runs.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • options (google.cloud.spanner_v1.types.TransactionOptions) –

    Required. Options for the new transaction.

    This corresponds to the options field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A transaction.

Return type

google.cloud.spanner_v1.types.Transaction

async commit(request: Optional[Union[google.cloud.spanner_v1.types.spanner.CommitRequest, dict]] = None, *, session: Optional[str] = None, transaction_id: Optional[bytes] = None, mutations: Optional[Sequence[google.cloud.spanner_v1.types.mutation.Mutation]] = None, single_use_transaction: Optional[google.cloud.spanner_v1.types.transaction.TransactionOptions] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.commit_response.CommitResponse[source]

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session.

On very rare occasions, Commit might return UNKNOWN. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

Parameters
  • request (Union[google.cloud.spanner_v1.types.CommitRequest, dict]) – The request object. The request for [Commit][google.spanner.v1.Spanner.Commit].

  • session (str) –

    Required. The session in which the transaction to be committed is running.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • transaction_id (bytes) –

    Commit a previously-started transaction.

    This corresponds to the transaction_id field on the request instance; if request is provided, this should not be set.

  • mutations (Sequence[google.cloud.spanner_v1.types.Mutation]) –

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    This corresponds to the mutations field on the request instance; if request is provided, this should not be set.

  • single_use_transaction (google.cloud.spanner_v1.types.TransactionOptions) –

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead.

    This corresponds to the single_use_transaction field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [Commit][google.spanner.v1.Spanner.Commit].

Return type

google.cloud.spanner_v1.types.CommitResponse

static common_billing_account_path(billing_account: str) str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) str

Returns a fully-qualified location string.

static common_organization_path(organization: str) str

Returns a fully-qualified organization string.

static common_project_path(project: str) str

Returns a fully-qualified project string.

async create_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.CreateSessionRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.Session[source]

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Parameters
  • request (Union[google.cloud.spanner_v1.types.CreateSessionRequest, dict]) – The request object. The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].

  • database (str) –

    Required. The database in which the new session is created.

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A session in the Cloud Spanner API.

Return type

google.cloud.spanner_v1.types.Session

static database_path(project: str, instance: str, database: str) str

Returns a fully-qualified database string.

async delete_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.DeleteSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Parameters
  • request (Union[google.cloud.spanner_v1.types.DeleteSessionRequest, dict]) – The request object. The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].

  • name (str) –

    Required. The name of the session to delete.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async execute_batch_dml(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlResponse[source]

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Statements are executed in sequential order. A request can succeed even if a statement fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.ExecuteBatchDmlResponse.status] field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.

Execution stops after the first failed statement; the remaining statements are not executed.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteBatchDmlRequest, dict]) – The request object. The request for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Contains a list

of [ResultSet][google.spanner.v1.ResultSet] messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure.

To check for DML statements that failed, use the following approach:

  1. Check the status in the response message. The [google.rpc.Code][google.rpc.Code] enum value OK indicates that all statements were executed successfully.

  2. If the status was not OK, check the number of result sets in the response. If the response contains N [ResultSet][google.spanner.v1.ResultSet] messages, then statement N+1 in the request failed.

Example 1:

  • Request: 5 DML statements, all executed successfully.

  • Response: 5 [ResultSet][google.spanner.v1.ResultSet] messages, with the status OK.

Example 2:

  • Request: 5 DML statements. The third statement has a syntax error.

  • Response: 2 [ResultSet][google.spanner.v1.ResultSet] messages, and a syntax error (INVALID_ARGUMENT) status. The number of [ResultSet][google.spanner.v1.ResultSet] messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

Return type

google.cloud.spanner_v1.types.ExecuteBatchDmlResponse

async execute_sql(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.result_set.ResultSet[source]

Executes an SQL statement, returning all results 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.

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.

Larger result sets can be fetched in streaming fashion by calling [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteSqlRequest, dict]) – The request object. The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Results from [Read][google.spanner.v1.Spanner.Read] or

[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Return type

google.cloud.spanner_v1.types.ResultSet

execute_streaming_sql(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) Awaitable[AsyncIterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]][source]

Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteSqlRequest, dict]) – The request object. The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Return type

AsyncIterable[google.cloud.spanner_v1.types.PartialResultSet]

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerAsyncClient

async get_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.GetSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.Session[source]

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Parameters
  • request (Union[google.cloud.spanner_v1.types.GetSessionRequest, dict]) – The request object. The request for [GetSession][google.spanner.v1.Spanner.GetSession].

  • name (str) –

    Required. The name of the session to retrieve.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A session in the Cloud Spanner API.

Return type

google.cloud.spanner_v1.types.Session

get_transport_class() Type[google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_sessions(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ListSessionsRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager[source]

Lists all sessions in a given database.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ListSessionsRequest, dict]) – The request object. The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].

  • database (str) –

    Required. The database in which to list sessions.

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [ListSessions][google.spanner.v1.Spanner.ListSessions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager

static parse_common_billing_account_path(path: str) Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) Dict[str, str]

Parse a project path into its component segments.

static parse_database_path(path: str) Dict[str, str]

Parses a database path into its component segments.

static parse_session_path(path: str) Dict[str, str]

Parses a session path into its component segments.

async partition_query(request: Optional[Union[google.cloud.spanner_v1.types.spanner.PartitionQueryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.PartitionResponse[source]

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

Parameters
  • request (Union[google.cloud.spanner_v1.types.PartitionQueryRequest, dict]) – The request object. The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

or [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Return type

google.cloud.spanner_v1.types.PartitionResponse

async partition_read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.PartitionReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.PartitionResponse[source]

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by [StreamingRead][google.spanner.v1.Spanner.StreamingRead] to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

Parameters
  • request (Union[google.cloud.spanner_v1.types.PartitionReadRequest, dict]) – The request object. The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

or [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Return type

google.cloud.spanner_v1.types.PartitionResponse

async read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.result_set.ResultSet[source]

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error.

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.

Larger result sets can be yielded in streaming fashion by calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ReadRequest, dict]) – The request object. The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Results from [Read][google.spanner.v1.Spanner.Read] or

[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Return type

google.cloud.spanner_v1.types.ResultSet

async rollback(request: Optional[Union[google.cloud.spanner_v1.types.spanner.RollbackRequest, dict]] = None, *, session: Optional[str] = None, transaction_id: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Parameters
  • request (Union[google.cloud.spanner_v1.types.RollbackRequest, dict]) – The request object. The request for [Rollback][google.spanner.v1.Spanner.Rollback].

  • session (str) –

    Required. The session in which the transaction to roll back is running.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • transaction_id (bytes) –

    Required. The transaction to roll back.

    This corresponds to the transaction_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static session_path(project: str, instance: str, database: str, session: str) str

Returns a fully-qualified session string.

streaming_read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) Awaitable[AsyncIterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]][source]

Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike [Read][google.spanner.v1.Spanner.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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ReadRequest, dict]) – The request object. The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Return type

AsyncIterable[google.cloud.spanner_v1.types.PartialResultSet]

property transport: google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

SpannerTransport

class google.cloud.spanner_v1.services.spanner.SpannerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Cloud Spanner API The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

Instantiates the spanner client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, SpannerTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

batch_create_sessions(request: Optional[Union[google.cloud.spanner_v1.types.spanner.BatchCreateSessionsRequest, dict]] = None, *, database: Optional[str] = None, session_count: Optional[int] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.BatchCreateSessionsResponse[source]

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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.BatchCreateSessionsRequest, dict]) – The request object. The request for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions].

  • database (str) –

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

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • session_count (int) –

    Required. The number of sessions to be created in this batch call. The API may return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to BatchCreateSessions (adjusting [session_count][google.spanner.v1.BatchCreateSessionsRequest.session_count] as necessary).

    This corresponds to the session_count field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions].

Return type

google.cloud.spanner_v1.types.BatchCreateSessionsResponse

begin_transaction(request: Optional[Union[google.cloud.spanner_v1.types.spanner.BeginTransactionRequest, dict]] = None, *, session: Optional[str] = None, options: Optional[google.cloud.spanner_v1.types.transaction.TransactionOptions] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.transaction.Transaction[source]

Begins a new transaction. This step can often be skipped: [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.

Parameters
  • request (Union[google.cloud.spanner_v1.types.BeginTransactionRequest, dict]) – The request object. The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].

  • session (str) –

    Required. The session in which the transaction runs.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • options (google.cloud.spanner_v1.types.TransactionOptions) –

    Required. Options for the new transaction.

    This corresponds to the options field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A transaction.

Return type

google.cloud.spanner_v1.types.Transaction

commit(request: Optional[Union[google.cloud.spanner_v1.types.spanner.CommitRequest, dict]] = None, *, session: Optional[str] = None, transaction_id: Optional[bytes] = None, mutations: Optional[Sequence[google.cloud.spanner_v1.types.mutation.Mutation]] = None, single_use_transaction: Optional[google.cloud.spanner_v1.types.transaction.TransactionOptions] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.commit_response.CommitResponse[source]

Commits a transaction. The request includes the mutations to be applied to rows in the database.

Commit might return an ABORTED error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If Commit returns ABORTED, the caller should re-attempt the transaction from the beginning, re-using the same session.

On very rare occasions, Commit might return UNKNOWN. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

Parameters
  • request (Union[google.cloud.spanner_v1.types.CommitRequest, dict]) – The request object. The request for [Commit][google.spanner.v1.Spanner.Commit].

  • session (str) –

    Required. The session in which the transaction to be committed is running.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • transaction_id (bytes) –

    Commit a previously-started transaction.

    This corresponds to the transaction_id field on the request instance; if request is provided, this should not be set.

  • mutations (Sequence[google.cloud.spanner_v1.types.Mutation]) –

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    This corresponds to the mutations field on the request instance; if request is provided, this should not be set.

  • single_use_transaction (google.cloud.spanner_v1.types.TransactionOptions) –

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead.

    This corresponds to the single_use_transaction field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [Commit][google.spanner.v1.Spanner.Commit].

Return type

google.cloud.spanner_v1.types.CommitResponse

static common_billing_account_path(billing_account: str) str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) str[source]

Returns a fully-qualified project string.

create_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.CreateSessionRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.Session[source]

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return NOT_FOUND.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

Parameters
  • request (Union[google.cloud.spanner_v1.types.CreateSessionRequest, dict]) – The request object. The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].

  • database (str) –

    Required. The database in which the new session is created.

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A session in the Cloud Spanner API.

Return type

google.cloud.spanner_v1.types.Session

static database_path(project: str, instance: str, database: str) str[source]

Returns a fully-qualified database string.

delete_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.DeleteSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

Parameters
  • request (Union[google.cloud.spanner_v1.types.DeleteSessionRequest, dict]) – The request object. The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].

  • name (str) –

    Required. The name of the session to delete.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

execute_batch_dml(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlResponse[source]

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Statements are executed in sequential order. A request can succeed even if a statement fails. The [ExecuteBatchDmlResponse.status][google.spanner.v1.ExecuteBatchDmlResponse.status] field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred.

Execution stops after the first failed statement; the remaining statements are not executed.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteBatchDmlRequest, dict]) – The request object. The request for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Contains a list

of [ResultSet][google.spanner.v1.ResultSet] messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure.

To check for DML statements that failed, use the following approach:

  1. Check the status in the response message. The [google.rpc.Code][google.rpc.Code] enum value OK indicates that all statements were executed successfully.

  2. If the status was not OK, check the number of result sets in the response. If the response contains N [ResultSet][google.spanner.v1.ResultSet] messages, then statement N+1 in the request failed.

Example 1:

  • Request: 5 DML statements, all executed successfully.

  • Response: 5 [ResultSet][google.spanner.v1.ResultSet] messages, with the status OK.

Example 2:

  • Request: 5 DML statements. The third statement has a syntax error.

  • Response: 2 [ResultSet][google.spanner.v1.ResultSet] messages, and a syntax error (INVALID_ARGUMENT) status. The number of [ResultSet][google.spanner.v1.ResultSet] messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

Return type

google.cloud.spanner_v1.types.ExecuteBatchDmlResponse

execute_sql(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.result_set.ResultSet[source]

Executes an SQL statement, returning all results 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.

Operations inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.

Larger result sets can be fetched in streaming fashion by calling [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteSqlRequest, dict]) – The request object. The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Results from [Read][google.spanner.v1.Spanner.Read] or

[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Return type

google.cloud.spanner_v1.types.ResultSet

execute_streaming_sql(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) Iterable[google.cloud.spanner_v1.types.result_set.PartialResultSet][source]

Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ExecuteSqlRequest, dict]) – The request object. The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Return type

Iterable[google.cloud.spanner_v1.types.PartialResultSet]

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpannerClient

get_session(request: Optional[Union[google.cloud.spanner_v1.types.spanner.GetSessionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.Session[source]

Gets a session. Returns NOT_FOUND if the session does not exist. This is mainly useful for determining whether a session is still alive.

Parameters
  • request (Union[google.cloud.spanner_v1.types.GetSessionRequest, dict]) – The request object. The request for [GetSession][google.spanner.v1.Spanner.GetSession].

  • name (str) –

    Required. The name of the session to retrieve.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A session in the Cloud Spanner API.

Return type

google.cloud.spanner_v1.types.Session

list_sessions(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ListSessionsRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager[source]

Lists all sessions in a given database.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ListSessionsRequest, dict]) – The request object. The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].

  • database (str) –

    Required. The database in which to list sessions.

    This corresponds to the database field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [ListSessions][google.spanner.v1.Spanner.ListSessions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager

static parse_common_billing_account_path(path: str) Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) Dict[str, str][source]

Parse a project path into its component segments.

static parse_database_path(path: str) Dict[str, str][source]

Parses a database path into its component segments.

static parse_session_path(path: str) Dict[str, str][source]

Parses a session path into its component segments.

partition_query(request: Optional[Union[google.cloud.spanner_v1.types.spanner.PartitionQueryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.PartitionResponse[source]

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

Parameters
  • request (Union[google.cloud.spanner_v1.types.PartitionQueryRequest, dict]) – The request object. The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

or [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Return type

google.cloud.spanner_v1.types.PartitionResponse

partition_read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.PartitionReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.spanner.PartitionResponse[source]

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by [StreamingRead][google.spanner.v1.Spanner.StreamingRead] to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token.

Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

Parameters
  • request (Union[google.cloud.spanner_v1.types.PartitionReadRequest, dict]) – The request object. The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

or [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

Return type

google.cloud.spanner_v1.types.PartitionResponse

read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_v1.types.result_set.ResultSet[source]

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a FAILED_PRECONDITION error.

Reads inside read-write transactions might return ABORTED. If this occurs, the application should restart the transaction from the beginning. See [Transaction][google.spanner.v1.Transaction] for more details.

Larger result sets can be yielded in streaming fashion by calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ReadRequest, dict]) – The request object. The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Results from [Read][google.spanner.v1.Spanner.Read] or

[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

Return type

google.cloud.spanner_v1.types.ResultSet

rollback(request: Optional[Union[google.cloud.spanner_v1.types.spanner.RollbackRequest, dict]] = None, *, session: Optional[str] = None, transaction_id: Optional[bytes] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None[source]

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and ultimately decides not to commit.

Rollback returns OK if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. Rollback never returns ABORTED.

Parameters
  • request (Union[google.cloud.spanner_v1.types.RollbackRequest, dict]) – The request object. The request for [Rollback][google.spanner.v1.Spanner.Rollback].

  • session (str) –

    Required. The session in which the transaction to roll back is running.

    This corresponds to the session field on the request instance; if request is provided, this should not be set.

  • transaction_id (bytes) –

    Required. The transaction to roll back.

    This corresponds to the transaction_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

static session_path(project: str, instance: str, database: str, session: str) str[source]

Returns a fully-qualified session string.

streaming_read(request: Optional[Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) Iterable[google.cloud.spanner_v1.types.result_set.PartialResultSet][source]

Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike [Read][google.spanner.v1.Spanner.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.

Parameters
  • request (Union[google.cloud.spanner_v1.types.ReadRequest, dict]) – The request object. The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Return type

Iterable[google.cloud.spanner_v1.types.PartialResultSet]

property transport: google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

SpannerTransport

class google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_v1.types.spanner.ListSessionsResponse]], request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest, response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_sessions requests.

This class thinly wraps an initial google.cloud.spanner_v1.types.ListSessionsResponse object, and provides an __aiter__ method to iterate through its sessions field.

If there are more pages, the __aiter__ method will make additional ListSessions requests and continue to iterate through the sessions field on the corresponding responses.

All the usual google.cloud.spanner_v1.types.ListSessionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager(method: Callable[[...], google.cloud.spanner_v1.types.spanner.ListSessionsResponse], request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest, response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_sessions requests.

This class thinly wraps an initial google.cloud.spanner_v1.types.ListSessionsResponse object, and provides an __iter__ method to iterate through its sessions field.

If there are more pages, the __iter__ method will make additional ListSessions requests and continue to iterate through the sessions field on the corresponding responses.

All the usual google.cloud.spanner_v1.types.ListSessionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters