The target-bigquery loader sends data into Google BigQuery after it was pulled from a source using an extractor
Available Variants
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-bigquery loader to your
project using
:meltano add
-
Configure the target-bigquery
settings using
:meltano config
meltano add loader target-bigquery --variant youcruit
meltano config target-bigquery set --interactive
Next steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
target-bigquery
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this loader.
This plugin has the following capabilities:
- about
- stream-maps
- schema-flattening
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
target-bigquery
settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
project_id
dataset
location
table_prefix
batch_size
max_batch_age
add_record_metadata
default_partition_column
table_configs
stream_maps
stream_map_config
flattening_enabled
flattening_max_depth
You can also list these settings using
with the meltano config
list
subcommand:
meltano config target-bigquery list
You can
override these settings or specify additional ones
in your meltano.yml
by adding the settings
key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Project Id (project_id)
-
Environment variable:
TARGET_BIGQUERY_PROJECT_ID
Google project id
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set project_id [value]
Dataset (dataset)
-
Environment variable:
TARGET_BIGQUERY_DATASET
Dataset to load data into
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set dataset [value]
Location (location)
-
Environment variable:
TARGET_BIGQUERY_LOCATION
Dataset location
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set location [value]
Table Prefix (table_prefix)
-
Environment variable:
TARGET_BIGQUERY_TABLE_PREFIX
Optional prefix to add to table names
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set table_prefix [value]
Batch Size (batch_size)
-
Environment variable:
TARGET_BIGQUERY_BATCH_SIZE
Maximum size of batches when records are streamed in. BATCH messages are not affected by this property.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set batch_size [value]
Max Batch Age (max_batch_age)
-
Environment variable:
TARGET_BIGQUERY_MAX_BATCH_AGE
Maximum time in minutes between state messages when records are streamed in. BATCH messages are not affected by this property.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set max_batch_age [value]
Add Record Metadata (add_record_metadata)
-
Environment variable:
TARGET_BIGQUERY_ADD_RECORD_METADATA
Add Singer Data Capture (SDC) metadata to records
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set add_record_metadata [value]
Default Partition Column (default_partition_column)
-
Environment variable:
TARGET_BIGQUERY_DEFAULT_PARTITION_COLUMN
Default partition column for all streams
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set default_partition_column [value]
Table Configs (table_configs)
-
Environment variable:
TARGET_BIGQUERY_TABLE_CONFIGS
Stream specific configs. Like partition keys.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set table_configs [value]
Stream Maps (stream_maps)
-
Environment variable:
TARGET_BIGQUERY_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_BIGQUERY_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_BIGQUERY_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_BIGQUERY_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-bigquery set flattening_max_depth [value]
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.