@google-cloud/spanner

module

The default export of the @google-cloud/spanner package is the Spanner class.

See Spanner and ClientConfig for client methods and configuration options.

Examples

Install the client library with npm:

npm install --save @google-cloud/spanner

Import the client library

const {Spanner} = require('@google-cloud/spanner');

Create a client that uses Application Default Credentials (ADC):

const client = new Spanner();

Create a client with explicit credentials:

const client = new Spanner({
  projectId: 'your-project-id',
  keyFilename: '/path/to/keyfile.json'
});

Full quickstart example:

// 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 = new 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);
  });

Properties

Database

static

Reference to the Database class.

See also
Database

Instance

static

Reference to the Instance class.

See also
Instance

Table

static

Reference to the Table class.

See also
Table

Transaction

static

Reference to the Transaction class.

See also
Transaction

TransactionRequest

static

Reference to the TransactionRequest class.

See also
TransactionRequest

v1

static

object

Properties

Parameter

DatabaseAdminClient

constructor

Reference to v1.DatabaseAdminClient

InstanceAdminClient

constructor

Reference to v1.InstanceAdminClient

SpannerClient

constructor

Reference to v1.SpannerClient