googleapis/nodejs-spanner

Name: nodejs-spanner

Owner: Google APIs

Description: Node.js client for Google Cloud Spanner: the world?s first fully managed relational database service to offer both strong consistency and horizontal scalability.

Created: 2017-10-19 16:17:31.0

Updated: 2018-05-22 18:32:53.0

Pushed: 2018-05-24 12:34:50.0

Homepage: https://cloud.google.com/spanner/

Size: 1397

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Google Cloud Platform logo

Cloud Spanner: Node.js Client

release level CircleCI AppVeyor codecov

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:

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
mports the Google Cloud client library
t Spanner = require('@google-cloud/spanner');

our Google Cloud Platform project ID
t projectId = 'YOUR_PROJECT_ID';

reates a client
t spanner = Spanner({
ojectId: projectId,


our Cloud Spanner instance ID
t instanceId = 'my-instance';

our Cloud Spanner database ID
t databaseId = 'my-database';

ets a reference to a Cloud Spanner instance and database
t instance = spanner.instance(instanceId);
t database = instance.database(databaseId);

he query to execute
t query = {
l: 'SELECT 1',


xecute a simple SQL statement
base
un(query)
hen(results => {
const rows = results[0];

rows.forEach(row => console.log(row));

atch(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 | 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.

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


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.