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. Sample code to get started:
$spannerClient = new SpannerClient();
try {
$formattedDatabase = $spannerClient->databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
$sessionCount = 0;
$response = $spannerClient->batchCreateSessions($formattedDatabase, $sessionCount);
} finally {
$spannerClient->close();
}
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.
Methods
getTransport
Returns the underlying transport.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\Transport\TransportInterface | |
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. |
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. |
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. |
__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 |
↳ 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 |
↳ 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.
| Parameters | |
|---|---|
| Name | Description |
database |
string
Required. The database in which the new sessions are created. |
sessionCount |
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 as necessary). |
optionalArgs |
array
Optional. |
↳ sessionTemplate |
Session
Parameters to be applied to each created session. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\BatchCreateSessionsResponse;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedDatabase The database in which the new sessions are created. Please see
* {@see SpannerClient::databaseName()} for help formatting this field.
* @param int $sessionCount 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).
*/
function batch_create_sessions_sample(string $formattedDatabase, int $sessionCount): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var BatchCreateSessionsResponse $response */
$response = $spannerClient->batchCreateSessions($formattedDatabase, $sessionCount);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedDatabase = SpannerClient::databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
$sessionCount = 0;
batch_create_sessions_sample($formattedDatabase, $sessionCount);
}
beginTransaction
Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the transaction runs. |
options |
Google\Cloud\Spanner\V1\TransactionOptions
Required. Options for the new transaction. |
optionalArgs |
array
Optional. |
↳ requestOptions |
RequestOptions
Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\SpannerClient;
use Google\Cloud\Spanner\V1\Transaction;
use Google\Cloud\Spanner\V1\TransactionOptions;
/**
* @param string $formattedSession The session in which the transaction runs. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
*/
function begin_transaction_sample(string $formattedSession): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$options = new TransactionOptions();
// Call the API and handle any network failures.
try {
/** @var Transaction $response */
$response = $spannerClient->beginTransaction($formattedSession, $options);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
begin_transaction_sample($formattedSession);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the transaction to be committed is running. |
mutations |
array<Google\Cloud\Spanner\V1\Mutation>
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. |
optionalArgs |
array
Optional. |
↳ transactionId |
string
Commit a previously-started transaction. |
↳ singleUseTransaction |
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 |
↳ returnCommitStats |
bool
If |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\CommitResponse;
use Google\Cloud\Spanner\V1\Mutation;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the transaction to be committed is running. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
*/
function commit_sample(string $formattedSession): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$mutations = [new Mutation()];
// Call the API and handle any network failures.
try {
/** @var CommitResponse $response */
$response = $spannerClient->commit($formattedSession, $mutations);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
commit_sample($formattedSession);
}
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".
| Parameters | |
|---|---|
| Name | Description |
database |
string
Required. The database in which the new session is created. |
optionalArgs |
array
Optional. |
↳ session |
Session
Required. The session to create. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\Session;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedDatabase The database in which the new session is created. Please see
* {@see SpannerClient::databaseName()} for help formatting this field.
*/
function create_session_sample(string $formattedDatabase): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var Session $response */
$response = $spannerClient->createSession($formattedDatabase);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedDatabase = SpannerClient::databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
create_session_sample($formattedDatabase);
}
deleteSession
Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the session to delete. |
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedName The name of the session to delete. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
*/
function delete_session_sample(string $formattedName): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
$spannerClient->deleteSession($formattedName);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = SpannerClient::sessionName('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
delete_session_sample($formattedName);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the DML statements should be performed. |
transaction |
Google\Cloud\Spanner\V1\TransactionSelector
Required. The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. |
statements |
array<Google\Cloud\Spanner\V1\ExecuteBatchDmlRequest\Statement>
Required. The list of statements to execute in this batch. Statements are executed
serially, such that the effects of statement Callers must provide at least one statement. |
seqno |
int
Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. |
optionalArgs |
array
Optional. |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\ExecuteBatchDmlRequest\Statement;
use Google\Cloud\Spanner\V1\ExecuteBatchDmlResponse;
use Google\Cloud\Spanner\V1\SpannerClient;
use Google\Cloud\Spanner\V1\TransactionSelector;
/**
* @param string $formattedSession The session in which the DML statements should be performed. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $statementsSql The DML string.
* @param int $seqno A per-transaction sequence number used to identify this request. This field
* makes each request idempotent such that if the request is received multiple
* times, at most one will succeed.
*
* The sequence number must be monotonically increasing within the
* transaction. If a request arrives for the first time with an out-of-order
* sequence number, the transaction may be aborted. Replays of previously
* handled requests will yield the same response as the first execution.
*/
function execute_batch_dml_sample(
string $formattedSession,
string $statementsSql,
int $seqno
): void {
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$transaction = new TransactionSelector();
$statement = (new Statement())
->setSql($statementsSql);
$statements = [$statement,];
// Call the API and handle any network failures.
try {
/** @var ExecuteBatchDmlResponse $response */
$response = $spannerClient->executeBatchDml($formattedSession, $transaction, $statements, $seqno);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$statementsSql = '[SQL]';
$seqno = 0;
execute_batch_dml_sample($formattedSession, $statementsSql, $seqno);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the SQL query should be performed. |
sql |
string
Required. The SQL string. |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. |
↳ params |
Struct
Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the |
↳ paramTypes |
array
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type |
↳ resumeToken |
string
If this request is resuming a previously interrupted SQL statement execution, |
↳ queryMode |
int
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. For allowed values, use constants defined on Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryMode |
↳ partitionToken |
string
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. |
↳ seqno |
int
A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. |
↳ queryOptions |
QueryOptions
Query optimizer configuration to use for the given query. |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ dataBoostEnabled |
bool
If this is for a partitioned query and this field is set to |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\ResultSet;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the SQL query should be performed. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $sql The SQL string.
*/
function execute_sql_sample(string $formattedSession, string $sql): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var ResultSet $response */
$response = $spannerClient->executeSql($formattedSession, $sql);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$sql = '[SQL]';
execute_sql_sample($formattedSession, $sql);
}
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 |
session |
string
Required. The session in which the SQL query should be performed. |
sql |
string
Required. The SQL string. |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. |
↳ params |
Struct
Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the |
↳ paramTypes |
array
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type |
↳ resumeToken |
string
If this request is resuming a previously interrupted SQL statement execution, |
↳ queryMode |
int
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. For allowed values, use constants defined on Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryMode |
↳ partitionToken |
string
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. |
↳ seqno |
int
A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. |
↳ queryOptions |
QueryOptions
Query optimizer configuration to use for the given query. |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ dataBoostEnabled |
bool
If this is for a partitioned query and this field is set to |
↳ timeoutMillis |
int
Timeout to use for this call. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\ServerStream | |
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Spanner\V1\PartialResultSet;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the SQL query should be performed. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $sql The SQL string.
*/
function execute_streaming_sql_sample(string $formattedSession, string $sql): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var ServerStream $stream */
$stream = $spannerClient->executeStreamingSql($formattedSession, $sql);
/** @var PartialResultSet $element */
foreach ($stream->readAll() as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$sql = '[SQL]';
execute_streaming_sql_sample($formattedSession, $sql);
}
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.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the session to retrieve. |
optionalArgs |
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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\Session;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedName The name of the session to retrieve. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
*/
function get_session_sample(string $formattedName): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var Session $response */
$response = $spannerClient->getSession($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = SpannerClient::sessionName('[PROJECT]', '[INSTANCE]', '[DATABASE]', '[SESSION]');
get_session_sample($formattedName);
}
listSessions
Lists all sessions in a given database.
| Parameters | |
|---|---|
| Name | Description |
database |
string
Required. The database in which to list sessions. |
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ filter |
string
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Spanner\V1\Session;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedDatabase The database in which to list sessions. Please see
* {@see SpannerClient::databaseName()} for help formatting this field.
*/
function list_sessions_sample(string $formattedDatabase): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $spannerClient->listSessions($formattedDatabase);
/** @var Session $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedDatabase = SpannerClient::databaseName('[PROJECT]', '[INSTANCE]', '[DATABASE]');
list_sessions_sample($formattedDatabase);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session used to create the partitions. |
sql |
string
Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
Read only snapshot transactions are supported, read/write and single use transactions are not. |
↳ params |
Struct
Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the |
↳ paramTypes |
array
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type |
↳ partitionOptions |
PartitionOptions
Additional options that affect how many partitions are created. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\PartitionResponse;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session used to create the partitions. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $sql The query request to generate partitions for. The request will fail if
* the query is not root partitionable. The query plan of a root
* partitionable query has a single distributed union operator. A distributed
* union operator conceptually divides one or more tables into multiple
* splits, remotely evaluates a subquery independently on each split, and
* then unions all results.
*
* This must not contain DML commands, such as INSERT, UPDATE, or
* DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
* PartitionedDml transaction for large, partition-friendly DML operations.
*/
function partition_query_sample(string $formattedSession, string $sql): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
/** @var PartitionResponse $response */
$response = $spannerClient->partitionQuery($formattedSession, $sql);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$sql = '[SQL]';
partition_query_sample($formattedSession, $sql);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session used to create the partitions. |
table |
string
Required. The name of the table in the database to be read. |
keySet |
Google\Cloud\Spanner\V1\KeySet
Required. It is not an error for the |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
Read only snapshot transactions are supported, read/write and single use transactions are not. |
↳ index |
string
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. |
↳ columns |
string[]
The columns of table to be returned for each row matching this request. |
↳ partitionOptions |
PartitionOptions
Additional options that affect how many partitions are created. |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\KeySet;
use Google\Cloud\Spanner\V1\PartitionResponse;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session used to create the partitions. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $table The name of the table in the database to be read.
*/
function partition_read_sample(string $formattedSession, string $table): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$keySet = new KeySet();
// Call the API and handle any network failures.
try {
/** @var PartitionResponse $response */
$response = $spannerClient->partitionRead($formattedSession, $table, $keySet);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$table = '[TABLE]';
partition_read_sample($formattedSession, $table);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the read should be performed. |
table |
string
Required. The name of the table in the database to be read. |
columns |
string[]
Required. The columns of table to be returned for each row matching this request. |
keySet |
Google\Cloud\Spanner\V1\KeySet
Required. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. |
↳ index |
string
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. |
↳ limit |
int
If greater than zero, only the first |
↳ resumeToken |
string
If this request is resuming a previously interrupted read, |
↳ partitionToken |
string
If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ dataBoostEnabled |
bool
If this is for a partitioned read and this field is set to |
↳ 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 | |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\KeySet;
use Google\Cloud\Spanner\V1\ResultSet;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the read should be performed. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $table The name of the table in the database to be read.
* @param string $columnsElement The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*/
function read_sample(string $formattedSession, string $table, string $columnsElement): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$columns = [$columnsElement,];
$keySet = new KeySet();
// Call the API and handle any network failures.
try {
/** @var ResultSet $response */
$response = $spannerClient->read($formattedSession, $table, $columns, $keySet);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$table = '[TABLE]';
$columnsElement = '[COLUMNS]';
read_sample($formattedSession, $table, $columnsElement);
}
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.
| Parameters | |
|---|---|
| Name | Description |
session |
string
Required. The session in which the transaction to roll back is running. |
transactionId |
string
Required. The transaction to roll back. |
optionalArgs |
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the transaction to roll back is running. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $transactionId The transaction to roll back.
*/
function rollback_sample(string $formattedSession, string $transactionId): void
{
// Create a client.
$spannerClient = new SpannerClient();
// Call the API and handle any network failures.
try {
$spannerClient->rollback($formattedSession, $transactionId);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$transactionId = '...';
rollback_sample($formattedSession, $transactionId);
}
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 |
session |
string
Required. The session in which the read should be performed. |
table |
string
Required. The name of the table in the database to be read. |
columns |
string[]
Required. The columns of table to be returned for each row matching this request. |
keySet |
Google\Cloud\Spanner\V1\KeySet
Required. If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order. It is not an error for the |
optionalArgs |
array
Optional. |
↳ transaction |
TransactionSelector
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. |
↳ index |
string
If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information. |
↳ limit |
int
If greater than zero, only the first |
↳ resumeToken |
string
If this request is resuming a previously interrupted read, |
↳ partitionToken |
string
If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. |
↳ requestOptions |
RequestOptions
Common options for this request. |
↳ dataBoostEnabled |
bool
If this is for a partitioned read and this field is set to |
↳ timeoutMillis |
int
Timeout to use for this call. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\ServerStream | |
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Spanner\V1\KeySet;
use Google\Cloud\Spanner\V1\PartialResultSet;
use Google\Cloud\Spanner\V1\SpannerClient;
/**
* @param string $formattedSession The session in which the read should be performed. Please see
* {@see SpannerClient::sessionName()} for help formatting this field.
* @param string $table The name of the table in the database to be read.
* @param string $columnsElement The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
* this request.
*/
function streaming_read_sample(
string $formattedSession,
string $table,
string $columnsElement
): void {
// Create a client.
$spannerClient = new SpannerClient();
// Prepare any non-scalar elements to be passed along with the request.
$columns = [$columnsElement,];
$keySet = new KeySet();
// Call the API and handle any network failures.
try {
/** @var ServerStream $stream */
$stream = $spannerClient->streamingRead($formattedSession, $table, $columns, $keySet);
/** @var PartialResultSet $element */
foreach ($stream->readAll() as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedSession = SpannerClient::sessionName(
'[PROJECT]',
'[INSTANCE]',
'[DATABASE]',
'[SESSION]'
);
$table = '[TABLE]';
$columnsElement = '[COLUMNS]';
streaming_read_sample($formattedSession, $table, $columnsElement);
}
Constants
SERVICE_NAME
Value: 'google.spanner.v1.Spanner'The name of the service.
SERVICE_ADDRESS
Value: 'spanner.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.