GCP BigQuery Data Transfer CLI

The Paradime SDK provides CLI commands to interact with the GCP BigQuery Data Transfer Service, allowing you to trigger BigQuery scheduled queries and list available scheduled queries with real-time monitoring capabilities.

🔑 API Access RequiredYou will need a GCP service account JSON key file with permissions to trigger and list BigQuery Data Transfer scheduled queries. The service account key file path and project ID can be provided as flags or set via environment variables.🔧 Configuration

Ensure the scheduled queries exist in the specified project and BigQuery Data Transfer location.
Confirm the service account has the necessary permissions to run and list scheduled queries.
Verify that the location matches where your scheduled queries are configured.

Trigger BigQuery Scheduled Queries

Trigger BigQuery scheduled queries by display name.

CLI Command

paradime run gcp-bigquery-transfer-trigger

Options

Flag	Type	Description
`--service-account-key-file`	Required, TEXT	Path to your GCP service account JSON key file. Can be set via `GCP_SERVICE_ACCOUNT_KEY_FILE` environment variable.
`--project`	Required, TEXT	Your GCP project ID. Can be set via `GCP_PROJECT_ID` environment variable.
`--location`	Optional, TEXT	BigQuery Data Transfer location (e.g. ‘us’, ‘eu’, ‘us-central1’). Default: `us`. Can be set via `GCP_LOCATION` environment variable.
`--scheduled-query-names`	Required, TEXT	Comma-separated display name(s) of the scheduled query/queries to trigger.
`--wait` / `--no-wait`	Optional, Flag	Wait for the scheduled query run to complete before returning. Default: `--wait`. Can be set via `GCP_BIGQUERY_TRANSFER_TRIGGER_WAIT` environment variable.
`--timeout`	Optional, INTEGER	Maximum time to wait for completion (in minutes). Only used with `--wait`. Default: 1440 (24 hours). Can be set via `GCP_BIGQUERY_TRANSFER_TRIGGER_TIMEOUT` environment variable.
`--help`	Optional, Flag	Show the help message and exit.

Recommended SetupFor security and convenience, set your GCP credentials as environment variables:

GCP_SERVICE_ACCOUNT_KEY_FILE="/path/to/service-account-key.json"
GCP_PROJECT_ID="your-gcp-project-id"
GCP_LOCATION="us"

Examples

# Trigger a single scheduled query (using environment variables)
paradime run gcp-bigquery-transfer-trigger \
  --scheduled-query-names "daily_revenue_rollup"

# Trigger multiple scheduled queries (comma-separated)
paradime run gcp-bigquery-transfer-trigger \
  --scheduled-query-names "daily_revenue_rollup,marketing_attribution"

List BigQuery Scheduled Queries

List all BigQuery scheduled queries.

CLI Command

paradime run gcp-bigquery-transfer-list

Options

Flag	Type	Description
`--service-account-key-file`	Required, TEXT	Path to your GCP service account JSON key file. Can be set via `GCP_SERVICE_ACCOUNT_KEY_FILE` environment variable.
`--project`	Required, TEXT	Your GCP project ID. Can be set via `GCP_PROJECT_ID` environment variable.
`--location`	Optional, TEXT	BigQuery Data Transfer location (e.g. ‘us’, ‘eu’, ‘us-central1’). Default: `us`. Can be set via `GCP_LOCATION` environment variable.
`--help`	Optional, Flag	Show the help message and exit.

Usage Examples

# List all scheduled queries (using environment variables)
paradime run gcp-bigquery-transfer-list

# With explicit credentials
paradime run gcp-bigquery-transfer-list \
  --service-account-key-file "/path/to/service-account-key.json" \
  --project "your-gcp-project-id" \
  --location "us"

Environment Variable Reference

Environment Variable	Description
`GCP_SERVICE_ACCOUNT_KEY_FILE`	Path to your GCP service account JSON key file
`GCP_PROJECT_ID`	Your GCP project ID
`GCP_LOCATION`	BigQuery Data Transfer location (e.g. ‘us’)
`GCP_BIGQUERY_TRANSFER_TRIGGER_WAIT`	Whether to wait for query run completion
`GCP_BIGQUERY_TRANSFER_TRIGGER_TIMEOUT`	Maximum time to wait for completion (minutes)

Workflow Integration

These GCP BigQuery Data Transfer CLI commands are designed to integrate seamlessly into your data pipeline workflows. For more information about integrating them into your Paradime workflows, see the Bolt Schedules documentation.

API Keys & Access

GraphQL API

Python SDK

Paradime CLI

Webhooks

Virtual Environments

GCP BigQuery Data Transfer CLI

Trigger BigQuery Scheduled Queries

CLI Command

Options

Examples

List BigQuery Scheduled Queries

CLI Command

Options

Usage Examples

Environment Variable Reference

Workflow Integration

​Trigger BigQuery Scheduled Queries

​CLI Command

​Options

​Examples

​List BigQuery Scheduled Queries

​CLI Command

​Options

​Usage Examples

​Environment Variable Reference

​Workflow Integration

Trigger BigQuery Scheduled Queries

CLI Command

Options

Examples

List BigQuery Scheduled Queries

CLI Command

Options

Usage Examples

Environment Variable Reference

Workflow Integration