Cloud Spanner V1 Client - Class SpannerClient (1.67.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class SpannerClient.

Service Description: Cloud Spanner API

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Spanner\V1\SpannerClient for the stable implementation

Namespace

Google \ Cloud \ Spanner \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchCreateSessions

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.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::batchCreateSessionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\BatchCreateSessionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\BatchCreateSessionsResponse`

batchWrite

Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied.

BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\BatchWriteRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

beginTransaction

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::beginTransactionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\BeginTransactionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\Transaction`

commit

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.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::commitAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\CommitRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\CommitResponse`

createSession

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".

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::createSessionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\CreateSessionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\Session`

deleteSession

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

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::deleteSessionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\DeleteSessionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

executeBatchDml

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql.

Statements are executed in sequential order. A request can succeed even if a statement fails. The 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.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::executeBatchDmlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ExecuteBatchDmlRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\ExecuteBatchDmlResponse`

executeSql

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 for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::executeSqlAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ExecuteSqlRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\ResultSet`

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.

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ExecuteSqlRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

getSession

Gets a session. Returns NOT_FOUND if the session does not exist.

This is mainly useful for determining whether a session is still alive.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::getSessionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\GetSessionRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\Session`

listSessions

Lists all sessions in a given database.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::listSessionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ListSessionsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

partitionQuery

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

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::partitionQueryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\PartitionQueryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\PartitionResponse`

partitionRead

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

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::partitionReadAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\PartitionReadRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\PartitionResponse`

read

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to 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 for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::readAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ReadRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Spanner\V1\ResultSet`

rollback

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 or 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.

The async variant is Google\Cloud\Spanner\V1\Client\SpannerClient::rollbackAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\RollbackRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

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.

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ReadRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

batchCreateSessionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\BatchCreateSessionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

beginTransactionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\BeginTransactionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

commitAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\CommitRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createSessionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\CreateSessionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSessionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\DeleteSessionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

executeBatchDmlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ExecuteBatchDmlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

executeSqlAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ExecuteSqlRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getSessionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\GetSessionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSessionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ListSessionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

partitionQueryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\PartitionQueryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

partitionReadAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\PartitionReadRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

readAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\ReadRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

rollbackAsync

Parameters
Name	Description
`request`	`Google\Cloud\Spanner\V1\RollbackRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::databaseName

Formats a string containing the fully-qualified path to represent a database resource.

Parameters
Name	Description
`project`	`string`
`instance`	`string`
`database`	`string`

Returns
Type	Description
`string`	The formatted database resource.

static::sessionName

Formats a string containing the fully-qualified path to represent a session resource.

Parameters
Name	Description
`project`	`string`
`instance`	`string`
`database`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted session resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

database: projects/{project}/instances/{instance}/databases/{database}
session: projects/{project}/instances/{instance}/databases/{database}/sessions/{session}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.