Google BigQuery

target-bigquery (youcruit variant)🥇

For loading data into BigQuery.

The target-bigquery loader sends data into Google BigQuery after it was pulled from a source using an extractor

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the target-bigquery loader to your project using
    meltano add
    :
  2. meltano add loader target-bigquery --variant youcruit
  3. Configure the target-bigquery settings using
    meltano config
    :
  4. meltano config target-bigquery set --interactive

Next steps

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
  • schema-flattening
  • stream-maps

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:

You can also list these settings using

meltano config
with the 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.

Add Record Metadata (add_record_metadata)

  • Environment variable: TARGET_BIGQUERY_ADD_RECORD_METADATA
  • Default Value: true

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]

Append Only (append_only)

  • Environment variable: TARGET_BIGQUERY_APPEND_ONLY
  • Default Value: false

Only append data; don't overwrite existing data


Configure this setting directly using the following Meltano command:

meltano config target-bigquery set append_only [value]

Batch Size (batch_size)

  • Environment variable: TARGET_BIGQUERY_BATCH_SIZE
  • Default Value: 100000

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]

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]

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]

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]

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]

Max Batch Age (max_batch_age)

  • Environment variable: TARGET_BIGQUERY_MAX_BATCH_AGE
  • Default Value: 5

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]

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]

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]

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]

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]

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]

Truncate Before Load (truncate_before_load)

  • Environment variable: TARGET_BIGQUERY_TRUNCATE_BEFORE_LOAD
  • Default Value: false

If tables should be truncated before new data is loaded


Configure this setting directly using the following Meltano command:

meltano config target-bigquery set truncate_before_load [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the target-bigquery loader to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add loader target-bigquery --variant youcruit

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/YouCruit/youcruit-target-bigquery
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • youcruit

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdkgoogle