@google-cloud/spanner

What is @google-cloud/spanner?

@google-cloud/spanner is a Node.js client library for Google Cloud Spanner, a fully managed, scalable, globally distributed, and strongly consistent database service. This package allows developers to interact with Cloud Spanner databases, perform CRUD operations, execute SQL queries, and manage database schemas.

What are @google-cloud/spanner's main functionalities?

Connecting to a Spanner Instance

This code demonstrates how to connect to a Spanner instance using the @google-cloud/spanner package. You need to provide your Google Cloud project ID and the Spanner instance ID.

const {Spanner} = require('@google-cloud/spanner');
const spanner = new Spanner({
  projectId: 'your-project-id',
});
const instance = spanner.instance('your-instance-id');

Creating a Database

This code shows how to create a new database within a Spanner instance. The `create` method returns an operation that you can wait for to ensure the database is created successfully.

const database = instance.database('your-database-id');
const [operation] = await database.create();
await operation.promise();
console.log(`Database ${database.id} created.`);

Executing a SQL Query

This code demonstrates how to execute a SQL query on a Spanner database. The `run` method executes the query and returns the result rows.

const query = {
  sql: 'SELECT * FROM your-table',
};
const [rows] = await database.run(query);
rows.forEach(row => console.log(row.toJSON()));

Inserting Data

This code shows how to insert data into a table in a Spanner database. The `insert` method is used to add a new row to the specified table.

const table = database.table('your-table');
await table.insert({
  column1: 'value1',
  column2: 'value2',
});
console.log('Data inserted.');

Updating Data

This code demonstrates how to update existing data in a table. The `update` method is used to modify the values of specified columns.

await table.update({
  column1: 'new-value1',
  column2: 'new-value2',
});
console.log('Data updated.');

Other packages similar to @google-cloud/spanner

pg

The `pg` package is a PostgreSQL client for Node.js. It allows you to interact with PostgreSQL databases, perform CRUD operations, and execute SQL queries. While `pg` is specific to PostgreSQL, @google-cloud/spanner is designed for Google Cloud Spanner, which offers additional features like global distribution and strong consistency.

mysql

The `mysql` package is a MySQL client for Node.js. It provides functionalities to connect to MySQL databases, execute queries, and manage database schemas. Similar to `pg`, `mysql` is specific to MySQL databases, whereas @google-cloud/spanner is tailored for Google Cloud Spanner.

sequelize

Sequelize is a promise-based Node.js ORM for various SQL databases, including PostgreSQL, MySQL, SQLite, and MSSQL. It provides an abstraction layer for database operations, making it easier to work with different databases. While Sequelize supports multiple databases, @google-cloud/spanner is specifically optimized for Google Cloud Spanner.

README

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.

• 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. The samples' README.md has instructions for running the samples.

Sample	Source Code	Try it
Batch	source code
CRUD	source code
Datatypes	source code
DML	source code
Indexing	source code
Quickstart	source code
Schema	source code
Struct	source code
Timestamp	source code
Transaction	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

4.6.1 (2020-01-29)

Bug Fixes

• enum, bytes, and Long types now accept strings (#816) (e63914d)
• fixed wrong return type of Database.run(..) (#810) (10c31d8), closes #809
• retry Session not found for Database.run(..) (#812) (6a48fd6)
• use PreciseDate instead of Date for min read timestamp (#807) (da8c2f8)