Node.js idiomatic client for Cloud Spanner.
Cloud Spanner is a fully managed, mission-critical, relational database service that offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions), and automatic, synchronous replication for high availability.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
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.
npm install --save @google-cloud/spanner
// Imports the Google Cloud client libraryconst Spanner = ;// Your Google Cloud Platform project IDconst projectId = 'YOUR_PROJECT_ID';// Creates a clientconst spanner =;// Your Cloud Spanner instance IDconst instanceId = 'my-instance';// Your Cloud Spanner database IDconst databaseId = 'my-database';// Gets a reference to a Cloud Spanner instance and databaseconst instance = spanner;const database = instance;// The query to executeconst query =sql: 'SELECT 1';// Execute a simple SQL statementdatabase;
Samples are in the
samples/ directory. The samples'
has instructions for running the samples.
|Sample||Source Code||Try it|
The Cloud Spanner Node.js Client API Reference documentation also contains samples.
This library follows Semantic Versioning.
This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the Contributing Guide.
Apache Version 2.0