@google-cloud/bigquery

Google BigQuery Client Library for Node.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@google-cloud/bigquery
391176.0.3a month ago6 years agoMinified + gzip package size for @google-cloud/bigquery in KB

Readme

Google Cloud Platform logorelease level npm version
Google BigQuery Client Library 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 Explainedexplained.
Table of contents:
Before you begin Installing the client library Using the client library

Quickstart

Before you begin

  1. Select or create a Cloud Platform projectprojects.
  2. Enable the Google BigQuery APIenableapi.
  3. Set up authentication with a service accountauth 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. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Add Column Load Append | source code | !Open in Cloud Shellshellimg | | Add Column Query Append | source code | !Open in Cloud Shellshellimg | | Add Empty Column | source code | !Open in Cloud Shellshellimg | | Auth View Tutorial | source code | !Open in Cloud Shellshellimg | | Browse Table | source code | !Open in Cloud Shellshellimg | | Cancel Job | source code | !Open in Cloud Shellshellimg | | Client JSON Credentials | source code | !Open in Cloud Shellshellimg | | Copy Table | source code | !Open in Cloud Shellshellimg | | Copy Table Multiple Source | source code | !Open in Cloud Shellshellimg | | Create Dataset | source code | !Open in Cloud Shellshellimg | | Create Job | source code | !Open in Cloud Shellshellimg | | Create Model | source code | !Open in Cloud Shellshellimg | | Create Routine | source code | !Open in Cloud Shellshellimg | | Create Routine DDL | source code | !Open in Cloud Shellshellimg | | Create Table | source code | !Open in Cloud Shellshellimg | | Create Table Clustered | source code | !Open in Cloud Shellshellimg | | Create Table Column ACL | source code | !Open in Cloud Shellshellimg | | Create Table Partitioned | source code | !Open in Cloud Shellshellimg | | Create Table Range Partitioned | source code | !Open in Cloud Shellshellimg | | Create View | source code | !Open in Cloud Shellshellimg | | Ddl Create View | source code | !Open in Cloud Shellshellimg | | Delete Dataset | source code | !Open in Cloud Shellshellimg | | Delete Label Dataset | source code | !Open in Cloud Shellshellimg | | Delete Label Table | source code | !Open in Cloud Shellshellimg | | Delete Model | source code | !Open in Cloud Shellshellimg | | Delete Routine | source code | !Open in Cloud Shellshellimg | | Delete Table | source code | !Open in Cloud Shellshellimg | | Extract Table Compressed | source code | !Open in Cloud Shellshellimg | | Extract Table JSON | source code | !Open in Cloud Shellshellimg | | Extract Table To GCS | source code | !Open in Cloud Shellshellimg | | Get Dataset | source code | !Open in Cloud Shellshellimg | | Get Dataset Labels | source code | !Open in Cloud Shellshellimg | | Get Job | source code | !Open in Cloud Shellshellimg | | BigQuery Get Model | source code | !Open in Cloud Shellshellimg | | Get Routine | source code | !Open in Cloud Shellshellimg | | BigQuery Get Table | source code | !Open in Cloud Shellshellimg | | Get Table Labels | source code | !Open in Cloud Shellshellimg | | Get View | source code | !Open in Cloud Shellshellimg | | Insert Rows As Stream | source code | !Open in Cloud Shellshellimg | | Inserting Data Types | source code | !Open in Cloud Shellshellimg | | BigQuery Label Dataset | source code | !Open in Cloud Shellshellimg | | Label Table | source code | !Open in Cloud Shellshellimg | | List Datasets | source code | !Open in Cloud Shellshellimg | | List Datasets By Label | source code | !Open in Cloud Shellshellimg | | List Jobs | source code | !Open in Cloud Shellshellimg | | BigQuery List Models | source code | !Open in Cloud Shellshellimg | | BigQuery List Models Streaming | source code | !Open in Cloud Shellshellimg | | List Routines | source code | !Open in Cloud Shellshellimg | | List Tables | source code | !Open in Cloud Shellshellimg | | Load CSV From GCS | source code | !Open in Cloud Shellshellimg | | Load CSV From GCS Autodetect | source code | !Open in Cloud Shellshellimg | | Load CSV From GCS Truncate | source code | !Open in Cloud Shellshellimg | | Load JSON From GCS | source code | !Open in Cloud Shellshellimg | | Load JSON From GCS Autodetect | source code | !Open in Cloud Shellshellimg | | Load JSON From GCS Truncate | source code | !Open in Cloud Shellshellimg | | Load Local File | source code | !Open in Cloud Shellshellimg | | Load Orc From GCS Truncate | source code | !Open in Cloud Shellshellimg | | Load Parquet From GCS Truncate | source code | !Open in Cloud Shellshellimg | | Load Table Clustered | source code | !Open in Cloud Shellshellimg | | Load Table GCS Avro | source code | !Open in Cloud Shellshellimg | | Load Table GCS Avro Truncate | source code | !Open in Cloud Shellshellimg | | Load Table GCSORC | source code | !Open in Cloud Shellshellimg | | Load Table GCS Parquet | source code | !Open in Cloud Shellshellimg | | Load Table Partitioned | source code | !Open in Cloud Shellshellimg | | Load Table URI Firestore | source code | !Open in Cloud Shellshellimg | | Nested Repeated Schema | source code | !Open in Cloud Shellshellimg | | Query | source code | !Open in Cloud Shellshellimg | | Query Batch | source code | !Open in Cloud Shellshellimg | | Query Clustered Table | source code | !Open in Cloud Shellshellimg | | Query Destination Table | source code | !Open in Cloud Shellshellimg | | Query Disable Cache | source code | !Open in Cloud Shellshellimg | | Query Dry Run | source code | !Open in Cloud Shellshellimg | | Query External GCS Perm | source code | !Open in Cloud Shellshellimg | | Query External GCS Temp | source code | !Open in Cloud Shellshellimg | | Query Legacy | source code | !Open in Cloud Shellshellimg | | Query Legacy Large Results | source code | !Open in Cloud Shellshellimg | | Query Pagination | source code | !Open in Cloud Shellshellimg | | Query Params Arrays | source code | !Open in Cloud Shellshellimg | | Query Params Named | source code | !Open in Cloud Shellshellimg | | Query Params Named Types | source code | !Open in Cloud Shellshellimg | | Query Params Positional | source code | !Open in Cloud Shellshellimg | | Query Params Positional Types | source code | !Open in Cloud Shellshellimg | | Query Params Structs | source code | !Open in Cloud Shellshellimg | | Query Params Timestamps | source code | !Open in Cloud Shellshellimg | | Query Stack Overflow | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg | | Relax Column | source code | !Open in Cloud Shellshellimg | | Relax Column Load Append | source code | !Open in Cloud Shellshellimg | | Relax Column Query Append | source code | !Open in Cloud Shellshellimg | | Remove Table Clustering | source code | !Open in Cloud Shellshellimg | | Set User Agent | source code | !Open in Cloud Shellshellimg | | Table Exists | source code | !Open in Cloud Shellshellimg | | Undelete Table | source code | !Open in Cloud Shellshellimg | | Update Dataset Access | source code | !Open in Cloud Shellshellimg | | Update Dataset Description | source code | !Open in Cloud Shellshellimg | | Update Dataset Expiration | source code | !Open in Cloud Shellshellimg | | BigQuery Update Model | source code | !Open in Cloud Shellshellimg | | Update Routine | source code | !Open in Cloud Shellshellimg | | Update Table Column ACL | source code | !Open in Cloud Shellshellimg | | Update Table Description | source code | !Open in Cloud Shellshellimg | | Update Table Expiration | source code | !Open in Cloud Shellshellimg | | Update View Query | source code | !Open in Cloud Shellshellimg |
The Google BigQuery Node.js Client API Referenceclient-docs 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@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

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 Stageslaunchstages

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 templates in directory.

License

Apache Version 2.0
See LICENSE