Wondering what’s next for npm?Check out our public roadmap! »

    @google-cloud/spanner
    TypeScript icon, indicating that this package has built-in type declarations

    5.9.0 • Public • Published

    Google Cloud Platform logo

    Cloud Spanner: Node.js Client

    release level npm version codecov

    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.

    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.
    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 Open in Cloud Shell
    Backups-create-with-encryption-key source code Open in Cloud Shell
    Backups-create source code Open in Cloud Shell
    Backups-delete source code Open in Cloud Shell
    Backups-get-database-operations source code Open in Cloud Shell
    Backups-get-operations source code Open in Cloud Shell
    Backups-get source code Open in Cloud Shell
    Backups-restore-with-encryption-key source code Open in Cloud Shell
    Backups-restore source code Open in Cloud Shell
    Backups-update source code Open in Cloud Shell
    Backups source code Open in Cloud Shell
    Batch source code Open in Cloud Shell
    CRUD source code Open in Cloud Shell
    Database-create-with-encryption-key source code Open in Cloud Shell
    Database-create-with-version-retention-period source code Open in Cloud Shell
    Datatypes source code Open in Cloud Shell
    DML source code Open in Cloud Shell
    Get-commit-stats source code Open in Cloud Shell
    Indexing source code Open in Cloud Shell
    Instance source code Open in Cloud Shell
    Numeric-add-column source code Open in Cloud Shell
    Numeric-query-parameter source code Open in Cloud Shell
    Numeric-update-data source code Open in Cloud Shell
    Queryoptions source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Rpc-priority source code Open in Cloud Shell
    Schema source code Open in Cloud Shell
    Struct source code Open in Cloud Shell
    Timestamp source code Open in Cloud Shell
    Transaction source code Open in Cloud Shell

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

    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 template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/spanner

    DownloadsWeekly Downloads

    34,945

    Version

    5.9.0

    License

    Apache-2.0

    Unpacked Size

    5.11 MB

    Total Files

    66

    Last publish

    Collaborators

    • avatar