@google-cloud/spanner

Cloud Spanner: Node.js Client

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.

• Cloud Spanner Node.js Client API Reference
• github.com/googleapis/nodejs-spanner
• Cloud Spanner Documentation

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

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
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 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

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

Changelog

v3.0.0

02-25-2019 12:38 PST

Breaking Changes

• breaking: refactor(transaction): split logic into new classes (#506)
• breaking: feat(timestamp): create new date/timestamp classes (#517)
• fix: run generator to bring in streaming retry configs (#448)