Google Cloud Platform logo

Google BigQuery: Node.js Client

release level CircleCI AppVeyor codecov

Node.js idiomatic client for BigQuery .

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 Google BigQuery 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/bigquery

Using the client library

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

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Creates a client
const bigquery = new BigQuery({
  projectId: projectId,

// The name for the new dataset
const datasetName = 'my_new_dataset';

// Creates the new dataset
  .then(results => {
    const dataset = results[0];

    console.log(`Dataset ${} created.`);
  .catch(err => {
    console.error('ERROR:', err);


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

Sample Source Code Try it
Datasets source code Open in Cloud Shell
Tables source code Open in Cloud Shell
Queries source code Open in Cloud Shell

The BigQuery 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