Google BigQuery Data Transfer Service: Node.js Client

release levelnpm version

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

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google BigQuery Data Transfer Service API.
  4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/bigquery-data-transfer

Using the client library

const bigqueryDataTransfer = require('@google-cloud/bigquery-data-transfer');const client = new bigqueryDataTransfer.v1.DataTransferServiceClient();async function quickstart() {  const projectId = await client.getProjectId();  // Iterate over all elements.  const formattedParent = client.projectPath(projectId, 'us-central1');  let nextRequest = {parent: formattedParent};  const options = {autoPaginate: false};  console.log('Data sources:');  do {    // Fetch the next page.    const responses = await client.listDataSources(nextRequest, options);    // The actual resources in a response.    const resources = responses[0];    // The next request if the response shows that there are more responses.    nextRequest = responses[1];    // The actual response object, if necessary.    // const rawResponse = responses[2];    resources.forEach(resource => {      console.log(`  ${resource.name}`);    });  } while (nextRequest);  console.log('\n\n');  console.log('Sources via stream:');  client    .listDataSourcesStream({parent: formattedParent})    .on('data', element => {      console.log(`  ${element.name}`);    });}quickstart();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Data_transfer_service.check_valid_credssource codeOpen in Cloud Shell
Data_transfer_service.create_transfer_configsource codeOpen in Cloud Shell
Data_transfer_service.delete_transfer_configsource codeOpen in Cloud Shell
Data_transfer_service.delete_transfer_runsource codeOpen in Cloud Shell
Data_transfer_service.enroll_data_sourcessource codeOpen in Cloud Shell
Data_transfer_service.get_data_sourcesource codeOpen in Cloud Shell
Data_transfer_service.get_transfer_configsource codeOpen in Cloud Shell
Data_transfer_service.get_transfer_runsource codeOpen in Cloud Shell
Data_transfer_service.list_data_sourcessource codeOpen in Cloud Shell
Data_transfer_service.list_transfer_configssource codeOpen in Cloud Shell
Data_transfer_service.list_transfer_logssource codeOpen in Cloud Shell
Data_transfer_service.list_transfer_runssource codeOpen in Cloud Shell
Data_transfer_service.schedule_transfer_runssource codeOpen in Cloud Shell
Data_transfer_service.start_manual_transfer_runssource codeOpen in Cloud Shell
Data_transfer_service.unenroll_data_sourcessource codeOpen in Cloud Shell
Data_transfer_service.update_transfer_configsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheGoogle BigQuery Data Transfer Service Node.js Client API Reference documentationalso contains samples.

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.

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.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

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 2025-10-30 UTC.