Cloud Bigtable: Node.js Client

Cloud Bigtable Client Library for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

• Cloud Bigtable Node.js Client API Reference
• Cloud Bigtable Documentation
• github.com/googleapis/nodejs-bigtable

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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 so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/bigtable

Using the client library

// Imports the Google Cloud client libraryconst {Bigtable} = require('@google-cloud/bigtable');const bigtable = newBigtable();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 thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Delete Snippets	source code
Filter Snippets	source code
Instances	source code
Quickstart	source code
Read Snippets	source code
Tableadmin	source code
Write Batch	source code
Write Conditionally	source code
Write Increment	source code
Simple Insert	source code

TheCloud Bigtable Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/bigtable@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE