Google Cloud Platform logo

Google BigQuery: Node.js Client

release level npm version codecov

BigQuery is Google's fully managed, petabyte scale, low cost analytics data warehouse. BigQuery is NoOps—there is no infrastructure to manage and you don't need a database administrator—so you can focus on analyzing data to find meaningful insights, use familiar SQL, and take advantage of our pay-as-you-go model.

Using the client library

  1. Select or create a Cloud Platform project.

  2. Enable billing for your project.

  3. Enable the Google BigQuery API.

  4. Set up authentication with a service account so you can access the API from your local workstation.

  5. Install the client library:

     npm install --save @google-cloud/bigquery
  6. Try an example:

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

  // Creates a client
  const bigquery = new BigQuery();

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

Samples

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

Sample Source Code Try it
Dataset create source code Open in Cloud Shell
Dataset delete source code Open in Cloud Shell
Dataset list source code Open in Cloud Shell
Browse rows source code Open in Cloud Shell
Copy table source code Open in Cloud Shell
Create table source code Open in Cloud Shell
Delete table source code Open in Cloud Shell
Extract table to GCS source code Open in Cloud Shell
Insert rows as stream source code Open in Cloud Shell
List tables source code Open in Cloud Shell
Load CSV from GCS source code Open in Cloud Shell
Load CSV from GCS autodetect source code Open in Cloud Shell
Load CSV from GCS truncate source code Open in Cloud Shell
Load JSON from GCS source code Open in Cloud Shell
Load JSON from GCS autodetect source code Open in Cloud Shell
Load JSON from GCS truncate source code Open in Cloud Shell
Load local file source code Open in Cloud Shell
Load ORC from GCS truncate source code Open in Cloud Shell
Load Parquet from GCS truncate source code Open in Cloud Shell
Query source code Open in Cloud Shell
Query named params source code Open in Cloud Shell
Query positional params source code Open in Cloud Shell

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

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.

License

Apache Version 2.0

See LICENSE

What's Next

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.