Cloud Spanner: Node.js Client
Node.js idiomatic client for Cloud Spanner .
Client API Reference
- About the NPM package
- Classes
- RPC Message Types
- Other Abstract Types
- Index of all
Quickstart
Before you begin
-
Select or create a Cloud Platform project.
-
Enable billing for your project.
-
Enable the Cloud Spanner API.
-
Set up authentication with a service account so you can access the API from your local workstation.
Installing the client library
npm install --save @google-cloud/spanner
Using the client library
// Imports the Google Cloud client library
const Spanner = require('@google-cloud/spanner');
// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';
// Creates a client
const spanner = Spanner({
projectId: projectId,
});
// Your Cloud Spanner instance ID
const instanceId = 'my-instance';
// Your Cloud Spanner database ID
const databaseId = 'my-database';
// Gets a reference to a Cloud Spanner instance and database
const instance = spanner.instance(instanceId);
const database = instance.database(databaseId);
// The query to execute
const query = {
sql: 'SELECT 1',
};
// Execute a simple SQL statement
database
.run(query)
.then(results => {
const rows = results[0];
rows.forEach(row => console.log(row));
})
.catch(err => {
console.error('ERROR:', err);
});
Samples
Samples are in the
samples/
directory. The samples'
README.md
has instructions for running the samples.
Sample | Source Code | Try it |
---|---|---|
Schema | source code |
![]() |
CRUD | source code |
![]() |
Indexing | source code |
![]() |
Transactions | source code |
![]() |
The Cloud Spanner Node.js Client API Reference documentation also contains samples.
Versioning
This library follows Semantic Versioning .
This library is considered to be in beta . This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
License
Apache Version 2.0
See LICENSE