Negatory. Postpone Mission.
    Wondering what’s next for npm?Check out our public roadmap! »

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

    3.5.0 • Public • Published

    Google Cloud Platform logo

    Cloud Bigtable: Node.js Client

    release level npm version codecov

    Cloud Bigtable Client Library for Node.js

    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 Bigtable 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/bigtable

    Using the client library

    // Imports the Google Cloud client library
    const {Bigtable} = require('@google-cloud/bigtable');
    
    const bigtable = new Bigtable();
    
    async function quickstart() {
      // Connect to an existing instance:my-bigtable-instance
      const instance = bigtable.instance(INSTANCE_ID);
    
      // Connect to an existing table:my-table
      const table = instance.table(TABLE_ID);
    
      // Read a row from my-table using a row key
      const [singleRow] = await table.row('r1').get();
    
      // Print the row key and data (column value, labels, timestamp)
      const rowData = JSON.stringify(singleRow.data, null, 4);
      console.log(`Row key: ${singleRow.id}\nData: ${rowData}`);
    }
    quickstart();

    Samples

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

    Sample Source Code Try it
    Filter Snippets source code Open in Cloud Shell
    Instances source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Read Snippets source code Open in Cloud Shell
    Tableadmin source code Open in Cloud Shell
    Write Batch source code Open in Cloud Shell
    Write Conditionally source code Open in Cloud Shell
    Write Increment source code Open in Cloud Shell
    Simple Insert source code Open in Cloud Shell

    The Cloud Bigtable 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/bigtable

    DownloadsWeekly Downloads

    26,791

    Version

    3.5.0

    License

    Apache-2.0

    Unpacked Size

    4.77 MB

    Total Files

    50

    Last publish

    Collaborators

    • avatar