-
Notifications
You must be signed in to change notification settings - Fork 1k
docs(spanner): snippets to set transaction options #2194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?php | ||
| /** | ||
| * Copyright 2026 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/spanner/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Spanner; | ||
|
|
||
| // [START spanner_isolation_level] | ||
| use Google\Cloud\Spanner\SpannerClient; | ||
| use Google\Cloud\Spanner\Transaction; | ||
| use Google\Cloud\Spanner\V1\TransactionOptions\IsolationLevel; | ||
|
|
||
| /** | ||
| * Shows how to run a Read Write transaction with isolation level options. | ||
| * | ||
| * Example: | ||
| * ``` | ||
| * isolation_level($instanceId, $databaseId); | ||
| * ``` | ||
| * | ||
| * @param string $instanceId The Spanner instance ID. | ||
| * @param string $databaseId The Spanner database ID. | ||
| */ | ||
| function isolation_level(string $instanceId, string $databaseId): void | ||
| { | ||
| // The isolation level specified at the client-level will be applied to all | ||
| // RW transactions. | ||
| $spanner = new SpannerClient([ | ||
| 'isolationLevel' => IsolationLevel::SERIALIZABLE | ||
| ]); | ||
| $instance = $spanner->instance($instanceId); | ||
| $database = $instance->database($databaseId); | ||
|
|
||
| // The isolation level specified at the request level takes precedence over | ||
| // the isolation level configured at the client level. | ||
| $database->runTransaction(function (Transaction $t) { | ||
| // Read an AlbumTitle. | ||
| $results = $t->execute('SELECT AlbumTitle from Albums WHERE SingerId = 1 and AlbumId = 1'); | ||
| foreach ($results as $row) { | ||
| printf('Current Album Title: %s' . PHP_EOL, $row['AlbumTitle']); | ||
| } | ||
|
|
||
| // Update the AlbumTitle. | ||
| $rowCount = $t->executeUpdate('UPDATE Albums SET AlbumTitle = \'A New Title\' WHERE SingerId = 1 and AlbumId = 1'); | ||
| printf('%d record(s) updated.' . PHP_EOL, $rowCount); | ||
| }, [ | ||
| 'transactionOptions' => [ | ||
| 'isolationLevel' => IsolationLevel::REPEATABLE_READ | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cloud Spanner only supports
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not true. Cloud Spanner supports setting the isolation level to |
||
| ] | ||
| ]); | ||
| } | ||
| // [END spanner_isolation_level] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <?php | ||
| /** | ||
| * Copyright 2026 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| /** | ||
| * For instructions on how to run the full sample: | ||
| * | ||
| * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/spanner/README.md | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Samples\Spanner; | ||
|
|
||
| // [START spanner_read_lock_mode] | ||
| use Google\Cloud\Spanner\SpannerClient; | ||
| use Google\Cloud\Spanner\Transaction; | ||
| use Google\Cloud\Spanner\V1\TransactionOptions\ReadWrite\ReadLockMode; | ||
|
|
||
| /** | ||
| * Shows how to run a Read Write transaction with read lock mode options. | ||
| * | ||
| * Example: | ||
| * ``` | ||
| * read_lock_mode($instanceId, $databaseId); | ||
| * ``` | ||
| * | ||
| * @param string $instanceId The Spanner instance ID. | ||
| * @param string $databaseId The Spanner database ID. | ||
| */ | ||
| function read_lock_mode(string $instanceId, string $databaseId): void | ||
| { | ||
| // The read lock mode specified at the client-level will be applied to all | ||
| // RW transactions. | ||
| $spanner = new SpannerClient([ | ||
| 'readLockMode' => ReadLockMode::OPTIMISTIC | ||
| ]); | ||
skuruppu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $instance = $spanner->instance($instanceId); | ||
| $database = $instance->database($databaseId); | ||
|
|
||
| // The read lock mode specified at the request level takes precedence over | ||
| // the read lock mode configured at the client level. | ||
| $database->runTransaction(function (Transaction $t) { | ||
| // Read an AlbumTitle. | ||
| $results = $t->execute('SELECT AlbumTitle from Albums WHERE SingerId = 2 and AlbumId = 1'); | ||
| foreach ($results as $row) { | ||
| printf('Current Album Title: %s' . PHP_EOL, $row['AlbumTitle']); | ||
| } | ||
|
|
||
| // Update the AlbumTitle. | ||
| $rowCount = $t->executeUpdate('UPDATE Albums SET AlbumTitle = \'A New Title\' WHERE SingerId = 2 and AlbumId = 1'); | ||
| printf('%d record(s) updated.' . PHP_EOL, $rowCount); | ||
| }, [ | ||
| 'transactionOptions' => [ | ||
| 'readLockMode' => ReadLockMode::PESSIMISTIC | ||
| ] | ||
|
Comment on lines
+65
to
+67
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The 'transactionOptions' => [
'readWrite' => [
'readLockMode' => ReadLockMode::PESSIMISTIC
]
]
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is necessary when setting it in the grpc API but not at the client-library level. See the unit tests for an example of setting |
||
| ]); | ||
| } | ||
| // [END spanner_read_lock_mode] | ||
|
|
||
| // The following 2 lines are only needed to run the samples | ||
| require_once __DIR__ . '/../../testing/sample_helpers.php'; | ||
| \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv); | ||
Uh oh!
There was an error while loading. Please reload this page.