Skip to content
Node.js client for Google Cloud Bigtable: Google's NoSQL Big Data database service.
TypeScript JavaScript Other
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: move to root (#413) Feb 7, 2019
.kokoro build: add Node 12 remove Node 11 (#521) Aug 1, 2019
proto refactor(ts): add proto generated files (#440) Mar 19, 2019
protos fix: allow calls with no request, add JSON proto Aug 2, 2019
samples fix(deps): update dependency yargs to v14 Aug 20, 2019
src docs: update jsdoc comments (#530) Aug 8, 2019
system-test fix: cancel streaming grpc request when user ends stream (#507) Jul 31, 2019
test remove unused properties (#528) Aug 5, 2019
.eslintignore chore: update nyc and eslint configs (#392) Dec 11, 2018
.eslintrc.yml Enable prefer-const in the eslint config (#305) Sep 20, 2018
.gitignore refactor(ts): convert to typescript (#426) Feb 28, 2019
.jsdoc.js docs: use the jsdoc-fresh theme (#518) Jul 31, 2019
.nycrc build: ignore proto files in test coverage (#489) May 28, 2019
.prettierignore Repo Migration (#1) Oct 31, 2017
.prettierrc Repo Migration (#1) Oct 31, 2017
.repo-metadata.json fix: "requires_billing " should be "requires_billing" (#498) Jun 13, 2019 chore: release 2.0.5 (#525) Aug 13, 2019 chore: make the CircleCI config consistent (#282) Aug 22, 2018 docs: update links in contrib guide (#421) Feb 14, 2019
LICENSE chore: update license file (#381) Dec 4, 2018 fix(docs): link to reference docs section on (#502) Jun 25, 2019
codecov.yaml Update kokoro config (#318) Oct 2, 2018
linkinator.config.json build: use config file for linkinator (#504) Jun 28, 2019
package.json chore: release 2.0.5 (#525) Aug 13, 2019
renovate.json chore: ignore package-lock.json (#269) Aug 7, 2018
synth.metadata docs: update jsdoc comments (#530) Aug 8, 2019 feat: update the admin APIs (#485) Jun 21, 2019
tsconfig.json refactor(ts): Linter & Formatter (#445) Mar 27, 2019
tslint.json refactor(ts): Linter & Formatter (#445) Mar 27, 2019

Google Cloud Platform logo

Cloud Bigtable: Node.js Client

release level npm version codecov

Cloud Bigtable Client Library for Node.js

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.
  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 = 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(, null, 4);
    console.log(`Row key: ${}\nData: ${rowData}`);


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

Sample Source Code Try it
Instances source code Open in Cloud Shell
Quickstart 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.


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


Contributions welcome! See the Contributing Guide.


Apache Version 2.0


You can’t perform that action at this time.