Newton's Programmatic Measurements
    Have ideas to improve npm?Join in the discussion! »

    TypeScript icon, indicating that this package has built-in type declarations

    0.16.0 • Public • Published
    Google Cloud Platform logo

    Cloud Bigtable: Node.js Client

    release level CircleCI AppVeyor codecov

    Node.js idiomatic client for Cloud Bigtable.

    Cloud Bigtable is Google's NoSQL Big Data database service. It's the same database that powers many core Google services, including Search, Analytics, Maps, and Gmail.

    Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

    Table of contents:


    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 Bigtable and Cloud Bigtable Admin APIs.

      Enable the APIs

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

    Using the client library

    // Imports the Google Cloud client library
    const Bigtable = require('@google-cloud/bigtable');
    // The name of the Cloud Bigtable instance
    const INSTANCE_NAME = 'my-bigtable-instance';
    // The name of the Cloud Bigtable table
    const TABLE_NAME = 'my-table';
    (async () => {
      try {
        // Creates a Bigtable client
        const bigtable = new Bigtable();
        // Connect to an existing instance:my-bigtable-instance
        const instance = bigtable.instance(INSTANCE_NAME);
        // Connect to an existing table:my-table
        const table = instance.table(TABLE_NAME);
        // Read a row from my-table using a row key
        let [singleRow] = await table.row('r1').get();
        // Print the row key and data (column value, labels, timestamp)
          `Row key: ${}\nData: ${JSON.stringify(
      } catch (err) {
        // Handle error performing the read operation
        console.error(`Error reading row r1:`, err);


    Samples are in the samples/ directory. The samples' has instructions for running the samples.

    Sample Source Code Try it
    Hello World source code Open in Cloud Shell
    Instance operations source code Open in Cloud Shell
    Table operations source code Open in Cloud Shell

    The Cloud Bigtable Node.js Client API Reference documentation also contains samples.


    This library follows Semantic Versioning.

    This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

    More Information: Google Cloud Platform Launch Stages


    Contributions welcome! See the Contributing Guide.


    Apache Version 2.0



    npm i @google-cloud/[email protected]





    Unpacked Size

    914 kB

    Total Files


    Last publish


    • avatar