Google Cloud Platform logo

Cloud Spanner: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Cloud Spanner .

Client API Reference


Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Cloud Spanner API.

    Enable the API

  4. 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
  .then(results => {
    const rows = results[0];

    rows.forEach(row => console.log(row));
  .catch(err => {
    console.error('ERROR:', err);


Samples are in the samples/ directory. The samples' has instructions for running the samples.

Sample Source Code Try it
Schema source code Open in Cloud Shell
CRUD source code Open in Cloud Shell
Indexing source code Open in Cloud Shell
Transactions source code Open in Cloud Shell

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