The target-gcs Meltano loader sends data into Google Cloud Storage after it was pulled from a source using an extractor.

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
  3. Add an extractor to pull data from a source

Installation and configuration #

  1. Add the target-gcs loader to your project using meltano add : 

    meltano add loader target-gcs
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

target-gcs requires the configuration of the following settings:

The settings for loader target-gcs that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

bucket_name #

The name of the GCS Bucket to sync the stream to

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config target-gcs set bucket_name <bucket_name>

export TARGET_GCS_BUCKET_NAME=<bucket_name>

credentials_file #

  • Environment variable: GOOGLE_APPLICATION_CREDENTIALS, alias: TARGET_GCS_CREDENTIALS_FILE
  • Default: $MELTANO_PROJECT_ROOT/client_secrets.json

The fully resolved path to the credentials json file. By default we will look in the meltano project directory root for a file called client_secrets.json

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config target-gcs set credentials_file <credentials_file>

export GOOGLE_APPLICATION_CREDENTIALS=<credentials_file>

date_format #

The date formate for the export date used in the bucket key path

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config target-gcs set date_format <date_format>

export TARGET_GCS_DATE_FORMAT=<date_format>

key_prefix #

This is the base key prefix which lets you define where the stream will write to in the bucket. By default, we use meltano/${MELTANO_EXTRACT__LOAD_SCHEMA}/ which is derived from the tap. For example tap-jira would end up in meltano/tap_jira/…

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config target-gcs set key_prefix <key_prefix>

export TARGET_GCS_KEY_PREFIX=<key_prefix>

key_naming_convention #

  • Environment variable: TARGET_GCS_KEY_NAMING_CONVENTION
  • Default: {stream}/export_date={date}/{timestamp}.jsonl

This is the naming convention for the key. Available values in the format string are stream (stream name), date, timestamp. By default this naming convention uses hive style partitioning

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config target-gcs set key_naming_convention <key_naming_convention>

export TARGET_GCS_KEY_NAMING_CONVENTION=<key_naming_convention>

Looking for help? #

If you're having trouble getting the target-gcs 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.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!