BigQuery Data Transfer API: Nodejs Client
This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority
BigQuery Data Transfer API client for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the BigQuery Data Transfer API API.
- Set up authentication so you can access theAPI from your local workstation.### Installing the client library
npm install @google-cloud/bigquery-data-transferSamples
Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| check valid creds | source code |
| create transfer config | source code |
| delete transfer config | source code |
| delete transfer run | source code |
| enroll data sources | source code |
| get data source | source code |
| get transfer config | source code |
| get transfer run | source code |
| list data sources | source code |
| list transfer configs | source code |
| list transfer logs | source code |
| list transfer runs | source code |
| schedule transfer runs | source code |
| start manual transfer runs | source code |
| unenroll data sources | source code |
| update transfer config | source code |
| cloud | source code |
Supported Node.js Versions
Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/bigquery-data-transfer@legacy-8 installs client librariesfor versions compatible with Node.js 8.
Versioning
This library followsSemantic Versioning.
More Information:Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See theContributing Guide.
Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.
License
Apache Version 2.0
SeeLICENSE
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-14 UTC.