Docs Support


Google Cloud Platform logo

Cloud Bigtable: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Cloud Bigtable .

Client API Reference


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

    Enable the 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 --save @google-cloud/bigtable

Using the client library

// Imports the Google Cloud client library
const Bigtable = require('@google-cloud/bigtable');

// Creates a client
const bigtable = new Bigtable();

// The name for the new instance
const instanceName = 'my-new-instance';

// Creates the new instance
  .createInstance(instanceName, {
    clusters: [
        name: 'my-cluster',
        location: 'us-central1-c',
        nodes: 3,
  .then(() => {
    console.log(`Instance ${instanceName} created.`);
  .catch(err => {
    console.log('ERROR:', err);


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

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


This library follows Semantic Versioning .

This library is considered to be in alpha . This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide .


Apache Version 2.0