The target-s3 loader sends data into S3 (Multi Format) 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:
Installation and configuration
-
Add the target-s3 loader to your project
using
:meltano add
-
Configure the target-s3 settings using
:meltano config
meltano add loader target-s3
meltano config target-s3 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-s3
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-s3
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:
aws_access_key
aws_secret_access_key
aws_region
bucket
prefix
append_date_to_prefix
append_date_to_prefix_grain
append_date_to_filename
append_date_to_filename_grain
format_type
flatten_records
set_dtype_string
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-s3 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.
Aws Access Key (aws_access_key)
-
Environment variable:
TARGET_S3_AWS_ACCESS_KEY
The aws secret access key for auth to S3.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set aws_access_key [value]
Aws Secret Access Key (aws_secret_access_key)
-
Environment variable:
TARGET_S3_AWS_SECRET_ACCESS_KEY
The aws secret access key for auth to S3.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set aws_secret_access_key [value]
Aws Region (aws_region)
-
Environment variable:
TARGET_S3_AWS_REGION
The aws region to target
Configure this setting directly using the following Meltano command:
meltano config target-s3 set aws_region [value]
Bucket (bucket)
-
Environment variable:
TARGET_S3_BUCKET
The aws bucket to target.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set bucket [value]
Prefix (prefix)
-
Environment variable:
TARGET_S3_PREFIX
The prefix for the key.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set prefix [value]
Append Date To Prefix (append_date_to_prefix)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_PREFIX
A flag to append the date to the key prefix.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set append_date_to_prefix [value]
Append Date To Prefix Grain (append_date_to_prefix_grain)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_PREFIX_GRAIN
The grain of the date to append to the prefix.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set append_date_to_prefix_grain [value]
Append Date To Filename (append_date_to_filename)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_FILENAME
A flag to append the date to the key filename.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set append_date_to_filename [value]
Append Date To Filename Grain (append_date_to_filename_grain)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_FILENAME_GRAIN
The grain of the date to append to the filename.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set append_date_to_filename_grain [value]
Format Type (format_type)
-
Environment variable:
TARGET_S3_FORMAT_TYPE
The format of the storage object.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set format_type [value]
Flatten Records (flatten_records)
-
Environment variable:
TARGET_S3_FLATTEN_RECORDS
A flag indictating to flatten records.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set flatten_records [value]
Set Dtype String (set_dtype_string)
-
Environment variable:
TARGET_S3_SET_DTYPE_STRING
A flag indictating to set dytpe to string.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set set_dtype_string [value]
Stream Maps (stream_maps)
-
Environment variable:
TARGET_S3_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-s3 set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_S3_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-s3 set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_S3_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_S3_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-s3 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.