BigQuery

Availability

Cloud Self-Managed Community Self-Managed Enterprise PyAirbyte

Support Level

Marketplace

Connector Version

0.4.3 (last updated 7 months ago)

Sync Success Rate

Usage Rate

Definition ID

bfd1ddf8-ae8a-4620-b1d7-55597d2ba08c

Overview

The BigQuery source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is running.

Resulting schema

The BigQuery source does not alter the schema present in your database. Depending on the destination connected to this source, however, the schema may be altered. See the destination's documentation for more details.

Data type mapping

The BigQuery data types mapping:

BigQuery Type	Resulting Type	Notes
BOOL	Boolean
INT64	Number
FLOAT64	Number
NUMERIC	Number
BIGNUMERIC	Number
STRING	String
BYTES	String
DATE	String	In ISO8601 format
DATETIME	String	In ISO8601 format
TIMESTAMP	String	In ISO8601 format
TIME	String
ARRAY	Array
STRUCT	Object
GEOGRAPHY	String

Features

Feature	Supported	Notes
Full Refresh Sync	Yes
Incremental Sync	Yes
Change Data Capture	No
SSL Support	Yes

Supported sync modes

The BigQuery source connector supports the following sync modes:

• Full Refresh Sync: Replaces all data in the destination with data from the source
• Incremental Sync: Appends new records based on a cursor field

Incremental sync behavior

Incremental sync uses a cursor field (typically a timestamp or incrementing ID) to track which records have been synced. The connector maintains state between syncs to resume from where the last sync left off.

How incremental sync works

The BigQuery source connector implements incremental sync by:

1. Querying with cursor filter: Uses WHERE cursor_field > last_cursor_value to fetch only new records
2. State management: Tracks the maximum cursor value from each sync for resumability
3. Parameterized queries: Uses BigQuery's parameterized query API for efficient execution

Cursor field requirements

• Monotonically increasing: Must be a timestamp, auto-incrementing ID, or other always-increasing field
• Non-null values: Records with null cursor values will be skipped
• Clustering/partitioning recommended: For optimal query performance, choose a cursor field that aligns with your table's clustering or partitioning strategy
• Any data type supported: The connector accepts any BigQuery data type as a cursor field

Recommended cursor field types

Based on BigQuery's query performance characteristics:

1. TIMESTAMP - Best for time-based incremental sync, works well with BigQuery's time-based partitioning
2. DATETIME - Good alternative to TIMESTAMP for timezone-agnostic scenarios
3. DATE - Suitable for daily batch incremental sync
4. INT64 - Excellent performance for auto-incrementing IDs
5. STRING - Supported but slower than numeric/date types for large datasets

BigQuery-specific performance considerations

Partitioned tables: If your source table is partitioned by date/timestamp, choose a cursor field that aligns with the partition column for optimal performance.

Note: The SQL examples below illustrate the underlying query patterns that the connector generates. While you select cursor fields through Airbyte's UI, understanding these patterns helps you make informed choices that optimize BigQuery performance and reduce costs.

-- Good: cursor field matches partition column
WHERE _PARTITIONTIME > @cursor_value

-- Less optimal: cursor field differs from partition column  
WHERE updated_at > @cursor_value AND _PARTITIONTIME >= '2023-01-01'

Clustered tables: If your table is clustered, using a clustering column as the cursor field can significantly improve query performance.

Query slots: Incremental queries consume BigQuery slots. For large tables:

• Use more selective cursor fields when possible
• Consider the frequency of incremental syncs vs. slot usage
• Monitor query performance in BigQuery's query history

State management and resumability

• Automatic state tracking: The connector automatically saves the maximum cursor value after each successful sync
• Resume capability: If a sync fails partway through, the next sync resumes from the last successfully processed cursor value
• Manual state reset: You can reset the sync state in Airbyte to re-sync historical data
• Per-stream state: Each table/stream maintains independent cursor state

Best practices for incremental sync

1. Choose the right cursor field:

   • Use updated_at or modified_time for frequently changing data
   • Use created_at or insert_time for append-only data
   • Choose fields that align with your table's clustering or partitioning for optimal performance

2. Optimize for BigQuery performance:

   • Align cursor fields with table partitioning when possible
   • Use clustering columns as cursor fields for better performance
   • Monitor BigQuery slot usage and query costs

3. Handle data quality:

   • Ensure cursor field values are always increasing
   • Monitor for gaps in cursor field values that might indicate data quality issues
   • Consider using TIMESTAMP fields over DATETIME for better timezone handling

4. Sync frequency considerations:

   • More frequent syncs reduce data latency but increase BigQuery slot usage
   • Balance sync frequency with BigQuery costs and slot availability
   • Consider BigQuery's streaming buffer behavior for very recent data

Getting started

Requirements

To use the BigQuery source, you'll need:

• A Google Cloud Project with BigQuery enabled
• A Google Cloud Service Account with the "BigQuery User" and "BigQuery Data Editor" roles in your GCP project
• A Service Account Key to authenticate into your Service Account

See the setup guide for more information about how to create the required resources.

Service account

In order for Airbyte to sync data from BigQuery, it needs credentials for a Service Account with the "BigQuery User" and "BigQuery Data Editor" roles, which grants permissions to run BigQuery jobs, write to BigQuery Datasets, and read table metadata. We highly recommend that this Service Account is exclusive to Airbyte for ease of permissioning and auditing. However, you can use a pre-existing Service Account if you already have one with the correct permissions.

The easiest way to create a Service Account is to follow GCP's guide for Creating a Service Account. Once you've created the Service Account, make sure to keep its ID handy as you will need to reference it when granting roles. Service Account IDs typically take the form <account-name>@<project-name>.iam.gserviceaccount.com

Then, add the service account as a Member in your Google Cloud Project with the "BigQuery User" role. To do this, follow the instructions for Granting Access in the Google documentation. The email address of the member you are adding is the same as the Service Account ID you just created.

At this point you should have a service account with the "BigQuery User" project-level permission.

Service account key

Service Account Keys are used to authenticate as Google Service Accounts. For Airbyte to leverage the permissions you granted to the Service Account in the previous step, you'll need to provide its Service Account Keys. See the Google documentation for more information about Keys.

Follow the Creating and Managing Service Account Keys guide to create a key. Airbyte currently supports JSON Keys only, so make sure you create your key in that format. As soon as you created the key, make sure to download it, as that is the only time Google will allow you to see its contents. Once you've successfully configured BigQuery as a source in Airbyte, delete this key from your computer.

Setup the BigQuery source in Airbyte

You should now have all the requirements needed to configure BigQuery as a source in the UI. You'll need the following information to configure the BigQuery source:

• Project ID
• Default Dataset ID [Optional]: the schema name if only one schema is interested. Dramatically boost source discover operation.
• Credentials JSON: the contents of your Service Account Key JSON file

Once you've configured BigQuery as a source, delete the Service Account Key from your computer.

Reference

Config fields reference

Field

Type

Property name

string

credentials_json

string

project_id

string

dataset_id

Changelog

Expand to review

Version	Date	Pull Request	Subject
0.4.3	2024-12-18	49875	Use a base image: airbyte/java-connector-base:1.0.0
0.4.2	2024-02-22	35503	Source BigQuery: replicating RECORD REPEATED fields
0.4.1	2024-01-24	34453	bump CDK version
0.4.0	2023-12-18	33484	Remove LEGACY state
0.3.0	2023-06-26	27737	License Update: Elv2
0.2.3	2022-10-13	15535	Update incremental query to avoid data missing when new data is inserted at the same time as a sync starts under non-CDC incremental mode
0.2.2	2022-09-22	16902	Source BigQuery: added user agent header
0.2.1	2022-09-14	15668	Wrap logs in AirbyteLogMessage
0.2.0	2022-07-26	14362	Integral columns are now discovered as int64 fields.
0.1.9	2022-07-14	14574	Removed additionalProperties:false from JDBC source connectors
0.1.8	2022-06-17	13864	Updated stacktrace format for any trace message errors
0.1.7	2022-04-11	11484	BigQuery connector escape column names
0.1.6	2022-02-14	10256	Add -XX:+ExitOnOutOfMemoryError JVM option
0.1.5	2021-12-23	8434	Update fields in source-connectors specifications
0.1.4	2021-09-30	#6524	Allow dataset_id null in spec
0.1.3	2021-09-16	#6051	Handle NPE dataset_id is not provided
0.1.2	2021-09-16	#6135	🐛 BigQuery source: Fix nested structs
0.1.1	2021-07-28	#4981	🐛 BigQuery source: Fix nested arrays
0.1.0	2021-07-22	#4457	🎉 New Source: Big Query.