Cloud Spanner: Node.js Client

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.

A comprehensive list of changes in each version may be found in the CHANGELOG.

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

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.
2. Enable billing for your project.
3. Enable the Cloud Spanner 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 @google-cloud/spanner

Using the client library

// Imports the Google Cloud client library
const {Spanner} = require('@google-cloud/spanner');

// Creates a client
const spanner = new Spanner({projectId});

// 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
const [rows] = await database.run(query);
console.log(`Query: ${rows.length} found.`);
rows.forEach(row => console.log(row));

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Backups-cancel	source code
Backups-create-with-encryption-key	source code
Backups-create	source code
Backups-delete	source code
Backups-get-database-operations	source code
Backups-get-operations	source code
Backups-get	source code
Backups-restore-with-encryption-key	source code
Backups-restore	source code
Backups-update	source code
Backups	source code
Batch	source code
CRUD	source code
Creates a new database with a specific default leader	source code
Database-create-with-encryption-key	source code
Database-create-with-version-retention-period	source code
Gets the schema definition of an existing database	source code
Gets the default leader option of an existing database	source code
Updates the default leader of an existing database	source code
Datatypes	source code
DML	source code
Get-commit-stats	source code
Gets the instance config metadata for the configuration nam6	source code
Creates a new value-storing index	source code
Creates a new index	source code
Executes a read-only SQL query using an existing index.	source code
Reads data using an existing storing index.	source code
Read data using an existing index.	source code
Indexing	source code
Instance-with-processing-units	source code
Instance	source code
Json-add-column	source code
Json-query-parameter	source code
Json-update-data	source code
Lists all databases on the selected instance	source code
Lists all the available instance configs for the selected project.	source code
Numeric-add-column	source code
Numeric-query-parameter	source code
Numeric-update-data	source code
Queryoptions	source code
Quickstart	source code
Sets a request tag for a single query	source code
Rpc-priority	source code
Schema	source code
Struct	source code
Timestamp	source code
Executes a read/write transaction with transaction and request tags	source code
Transaction	source code

The Cloud Spanner Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be 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 stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE