README.md

Google Cloud BigQuery: Node.js Client

Google BigQuery Client Library for Node.js

• Google Cloud BigQuery Node.js Client API Reference
• Google Cloud BigQuery Documentation
• github.com/googleapis/nodejs-bigquery

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client 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 the Google Cloud BigQuery API.
3. 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/bigquery

Using the client library

// Imports the Google Cloud client library
const {BigQuery} = require('@google-cloud/bigquery');

async function createDataset() {
  // Creates a client
  const bigqueryClient = new BigQuery();

  // Create the dataset
  const [dataset] = await bigqueryClient.createDataset(datasetName);
  console.log(`Dataset ${dataset.id} created.`);
}
createDataset();

Samples

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

Sample	Source Code	Try it
Add Column Load Append	source code
Add Column Query Append	source code
Add Empty Column	source code
Browse Rows	source code
Cancel Job	source code
Client JSON Credentials	source code
Copy Table	source code
Copy Table Multiple Source	source code
Create Dataset	source code
Create Job	source code
Create Table	source code
Create Table Partitioned	source code
Create View	source code
Ddl Create View	source code
Delete Dataset	source code
Delete Label Dataset	source code
Delete Label Table	source code
Delete Model	source code
Delete Table	source code
Extract Table Compressed	source code
Extract Table JSON	source code
Extract Table To GCS	source code
Get Dataset	source code
Get Dataset Labels	source code
Get Job	source code
BigQuery Get Model	source code
BigQuery Get Table	source code
Get Table Labels	source code
Get View	source code
Insert Rows As Stream	source code
BigQuery Label Dataset	source code
Label Table	source code
List Datasets	source code
List Datasets By Label	source code
List Jobs	source code
BigQuery List Models	source code
BigQuery List Models Streaming	source code
List Tables	source code
Load CSV From GCS	source code
Load CSV From GCS Autodetect	source code
Load CSV From GCS Truncate	source code
Load JSON From GCS	source code
Load JSON From GCS Autodetect	source code
Load JSON From GCS Truncate	source code
Load Local File	source code
Load Orc From GCS Truncate	source code
Load Parquet From GCS Truncate	source code
Load Table GCS Avro	source code
Load Table GCS Avro Truncate	source code
Load Table GCSORC	source code
Load Table GCS Parquet	source code
Load Table Partitioned	source code
Nested Repeated Schema	source code
Query	source code
Query Batch	source code
Query Destination Table	source code
Query Disable Cache	source code
Query Dry Run	source code
Query Legacy	source code
Query Legacy Large Results	source code
Query Params Arrays	source code
Query Params Named	source code
Query Params Positional	source code
Query Params Structs	source code
Query Params Timestamps	source code
Query Stack Overflow	source code
Quickstart	source code
Relax Column	source code
Relax Column Load Append	source code
Relax Column Query Append	source code
Undelete Table	source code
Update Dataset Access	source code
Update Dataset Description	source code
Update Dataset Expiration	source code
BigQuery Update Model	source code
Update Table Description	source code
Update Table Expiration	source code
Update View Query	source code

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

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

• Legacy versions will not be tested in continuous integration.
• Some security patches may not be able to be backported.
• Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

• legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

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

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

License

Apache Version 2.0

See LICENSE