Cloud Bigtable Client Library for Node.js
- 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 older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
- Select or create a Cloud Platform project.
- Enable the Cloud Bigtable API.
- Set up authentication with a service account so you can access the API from your local workstation.
npm install @google-cloud/bigtable// Imports the Google Cloud client library
const Bigtable = require('@google-cloud/bigtable');
async function quickstart(
INSTANCE_ID = 'my-instance', // ID of the Cloud Bigtable instance
TABLE_ID = 'my-table' // ID of the Cloud Bigtable table
) {
const bigtable = Bigtable();
// 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}`);
}Samples are in the samples/ directory. The samples' README.md
has instructions for running the samples.
| Sample | Source Code | Try it |
|---|---|---|
| Instances | source code |  |
| Quickstart | source code | |
| Tableadmin | source code | |
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
See LICENSE