Google BigQuery Reservation: Node.js Client

release level npm version

BigQuery Reservation client for Node.js

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

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

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google BigQuery Reservation 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 @google-cloud/bigquery-reservation

Using the client library

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

// Creates a client
const client = new ReservationServiceClient();

// project = 'my-project' // Project to list reservations for.
// location = 'US' // BigQuery location.

async function listReservations() {
  const [reservations] = await client.listReservations({
    parent: `projects/${project}/locations/${location}`,
  });`found ${reservations.length} reservations`);;

async function listCapacityCommitments() {
  const [commitments] = await client.listCapacityCommitments({
    parent: `projects/${project}/locations/${location}`,
  });`found ${commitments.length} commitments`);;



Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Reservation_service.create_assignmentsource codeOpen in Cloud Shell
Reservation_service.create_capacity_commitmentsource codeOpen in Cloud Shell
Reservation_service.create_reservationsource codeOpen in Cloud Shell
Reservation_service.delete_assignmentsource codeOpen in Cloud Shell
Reservation_service.delete_capacity_commitmentsource codeOpen in Cloud Shell
Reservation_service.delete_reservationsource codeOpen in Cloud Shell
Reservation_service.get_bi_reservationsource codeOpen in Cloud Shell
Reservation_service.get_capacity_commitmentsource codeOpen in Cloud Shell
Reservation_service.get_reservationsource codeOpen in Cloud Shell
Reservation_service.list_assignmentssource codeOpen in Cloud Shell
Reservation_service.list_capacity_commitmentssource codeOpen in Cloud Shell
Reservation_service.list_reservationssource codeOpen in Cloud Shell
Reservation_service.merge_capacity_commitmentssource codeOpen in Cloud Shell
Reservation_service.move_assignmentsource codeOpen in Cloud Shell
Reservation_service.search_all_assignmentssource codeOpen in Cloud Shell
Reservation_service.search_assignmentssource codeOpen in Cloud Shell
Reservation_service.split_capacity_commitmentsource codeOpen in Cloud Shell
Reservation_service.update_assignmentsource codeOpen in Cloud Shell
Reservation_service.update_bi_reservationsource codeOpen in Cloud Shell
Reservation_service.update_capacity_commitmentsource codeOpen in Cloud Shell
Reservation_service.update_reservationsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Google BigQuery Reservation 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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-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, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/bigquery-reservation@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be 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 stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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 templates in directory.


Apache Version 2.0