-
Notifications
You must be signed in to change notification settings - Fork 109
chore: sample for snapshot isolation #2265
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 3 commits
2a570b8
e73331f
f09e627
1c03bdf
82eb764
470eb56
5772cb2
0da8b77
fd1d72f
8c56a11
33c251e
aca1a43
95f7260
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. Let's rename this to repeatable-read.js. 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. done |
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,93 @@ | ||||||||
// Copyright 2025 Google LLC | ||||||||
// | ||||||||
// 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. | ||||||||
|
||||||||
// sample-metadata: | ||||||||
// title: Performs a read-write transaction with isolation level option | ||||||||
// usage: node snapshot-isolation.js <INSTANCE_ID> <DATABASE_ID> <PROJECT_ID> | ||||||||
|
||||||||
'use strict'; | ||||||||
|
||||||||
function main( | ||||||||
instanceId = 'my-instance', | ||||||||
databaseId = 'my-database', | ||||||||
projectId = 'my-project-id' | ||||||||
) { | ||||||||
// [START spanner_isolation_level] | ||||||||
// Imports the Google Cloud Spanner client library | ||||||||
const {Spanner, protos} = require('@google-cloud/spanner'); | ||||||||
const snapshotIsolationOptionsForClient = { | ||||||||
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. probably calls this 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. done |
||||||||
defaultTransactionOptions: { | ||||||||
isolationLevel: | ||||||||
protos.google.spanner.v1.TransactionOptions.IsolationLevel.SERIALIZABLE, | ||||||||
}, | ||||||||
}; | ||||||||
|
||||||||
// Instantiates a client with defaultTransactionOptions | ||||||||
const spanner = new Spanner({ | ||||||||
projectId: projectId, | ||||||||
defaultTransactionOptions: snapshotIsolationOptionsForClient, | ||||||||
}); | ||||||||
|
||||||||
function spannerSnapshotIsolation() { | ||||||||
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. I would call this 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. updated |
||||||||
// Gets a reference to a Cloud Spanner instance and database | ||||||||
const instance = spanner.instance(instanceId); | ||||||||
const database = instance.database(databaseId); | ||||||||
// The isolation level specified at the request level takes precedence over the isolation level configured at the client level. | ||||||||
const snapshotIsolationOptionsForRequest = { | ||||||||
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.
Suggested change
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. done 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. Same here with naming, something like 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. done |
||||||||
isolationLevel: | ||||||||
protos.google.spanner.v1.TransactionOptions.IsolationLevel | ||||||||
.REPEATABLE_READ, | ||||||||
}; | ||||||||
|
||||||||
database.getTransaction( | ||||||||
snapshotIsolationOptionsForRequest, | ||||||||
async (err, transaction) => { | ||||||||
if (err) { | ||||||||
console.error(err); | ||||||||
return; | ||||||||
} | ||||||||
try { | ||||||||
const [rowCount] = await transaction.runUpdate({ | ||||||||
sql: 'INSERT Singers (SingerId, FirstName, LastName) VALUES (1, @firstName, @lastName)', | ||||||||
params: { | ||||||||
firstName: 'Marc', | ||||||||
lastName: 'Richards', | ||||||||
}, | ||||||||
}); | ||||||||
|
||||||||
console.log( | ||||||||
`Successfully inserted ${rowCount} record into the Singers table.` | ||||||||
); | ||||||||
await transaction.commit(); | ||||||||
console.log( | ||||||||
'Successfully executed read-write transaction with isolationLevel option.' | ||||||||
); | ||||||||
} catch (err) { | ||||||||
console.error('ERROR:', err); | ||||||||
} finally { | ||||||||
transaction.end(); | ||||||||
// Close the database when finished. | ||||||||
await database.close(); | ||||||||
} | ||||||||
} | ||||||||
); | ||||||||
} | ||||||||
spannerSnapshotIsolation(); | ||||||||
// [END spanner_isolation_level] | ||||||||
} | ||||||||
process.on('unhandledRejection', err => { | ||||||||
console.error(err.message); | ||||||||
process.exitCode = 1; | ||||||||
}); | ||||||||
main(...process.argv.slice(2)); |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -675,6 +675,24 @@ describe('Autogenerated Admin Clients', () => { | |
); | ||
}); | ||
|
||
// isolation_level_option | ||
it('should run read-write transaction with isolation level option set', () => { | ||
const output = execSync( | ||
`node snapshot-isolation.js ${INSTANCE_ID} ${DATABASE_ID} ${PROJECT_ID}` | ||
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. Same here with naming. 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. done |
||
); | ||
console.log(output); | ||
assert.match( | ||
output, | ||
new RegExp('Successfully inserted 1 record into the Singers table.') | ||
); | ||
assert.match( | ||
output, | ||
new RegExp( | ||
'Successfully executed read-write transaction with isolationLevel option.' | ||
) | ||
); | ||
}); | ||
|
||
// query with RPC priority for run command | ||
it('should use RPC priority from request options for run command', async () => { | ||
const output = execSync( | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here with naming: repeatable-read.js
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done