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-s3meltano config target-s3 set --interactiveNext 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
- 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-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:
append_date_to_filenameappend_date_to_filename_grainappend_date_to_prefixappend_date_to_prefix_graincloud_provider.aws.aws_access_key_idcloud_provider.aws.aws_bucketcloud_provider.aws.aws_endpoint_overridecloud_provider.aws.aws_profile_namecloud_provider.aws.aws_regioncloud_provider.aws.aws_secret_access_keycloud_provider.aws.aws_session_tokencloud_provider.cloud_provider_typeformat.format_parquet.validateformat.format_typeinclude_process_datepartition_name_enabledprefixstream_name_path_overrideuse_raw_stream_namemax_batch_agemax_batch_size
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
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.
Append Date To Filename (append_date_to_filename)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_FILENAME -
Default Value:
true
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 -
Default Value:
day
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]Append Date To Prefix (append_date_to_prefix)
-
Environment variable:
TARGET_S3_APPEND_DATE_TO_PREFIX -
Default Value:
true
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 -
Default Value:
day
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]Cloud Provider AWS AWS Access Key ID (cloud_provider.aws.aws_access_key_id)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_ACCESS_KEY_ID
Your AWS access key ID.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_access_key_id [value]Cloud Provider AWS AWS Bucket (cloud_provider.aws.aws_bucket)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_BUCKET
Your AWS access key ID.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_bucket [value]Cloud Provider AWS AWS Endpoint Override (cloud_provider.aws.aws_endpoint_override)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_ENDPOINT_OVERRIDE
The AWS endpoint url to use for testing purposes.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_endpoint_override [value]Cloud Provider AWS AWS Profile Name (cloud_provider.aws.aws_profile_name)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_PROFILE_NAME
Your AWS profile name to optionally use for auth.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_profile_name [value]Cloud Provider AWS AWS Region (cloud_provider.aws.aws_region)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_REGION
Your AWS region.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_region [value]Cloud Provider AWS AWS Secret Access Key (cloud_provider.aws.aws_secret_access_key)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_SECRET_ACCESS_KEY
Your AWS secret access key.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_secret_access_key [value]Cloud Provider AWS AWS Session Token (cloud_provider.aws.aws_session_token)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_AWS_AWS_SESSION_TOKEN
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider aws.aws_session_token [value]Cloud Provider Cloud Provider Type (cloud_provider.cloud_provider_type)
-
Environment variable:
TARGET_S3_CLOUD_PROVIDER_CLOUD_PROVIDER_TYPE -
Default Value:
aws
The cloud provider type to use.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set cloud_provider cloud_provider_type [value]Format Format Parquet Validate (format.format_parquet.validate)
-
Environment variable:
TARGET_S3_FORMAT_FORMAT_PARQUET_VALIDATE -
Default Value:
false
This flag determines whether the data types of incoming data elements should be validated. When set True, a schema is created from the first record and all subsequent records that don't match that data type are cast. Default False.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set format format_parquet.validate [value]Format Format Type (format.format_type)
-
Environment variable:
TARGET_S3_FORMAT_FORMAT_TYPE
The format type of the output files.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set format format_type [value]Include Process Date (include_process_date)
-
Environment variable:
TARGET_S3_INCLUDE_PROCESS_DATE -
Default Value:
false
A flag indicating whether to append _process_date to record.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set include_process_date [value]Partition Name Enabled (partition_name_enabled)
-
Environment variable:
TARGET_S3_PARTITION_NAME_ENABLED -
Default Value:
false
A flag (only works if append_date_to_prefix is enabled) to have partitioning name formatted e.g. 'year=2023/month=01/day=01'.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set partition_name_enabled [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]Stream Name Path Override (stream_name_path_override)
-
Environment variable:
TARGET_S3_STREAM_NAME_PATH_OVERRIDE
The S3 key stream name override.
Configure this setting directly using the following Meltano command:
meltano config target-s3 set stream_name_path_override [value]Use Raw Stream Name (use_raw_stream_name)
-
Environment variable:
TARGET_S3_USE_RAW_STREAM_NAME -
Default Value:
false
A flag to force the filename to be identical to the stream name
Configure this setting directly using the following Meltano command:
meltano config target-s3 set use_raw_stream_name [value]Maximum Batch Age (max_batch_age)
-
Environment variable:
TARGET_S3_MAX_BATCH_AGE -
Default Value:
5
Maximum time in minutes between state messages when records are streamed in
Configure this setting directly using the following Meltano command:
meltano config target-s3 set max_batch_age [value]Maximum Batch Size (max_batch_size)
-
Environment variable:
TARGET_S3_MAX_BATCH_SIZE -
Default Value:
10000
Maximum size of batches when records are streamed in
Configure this setting directly using the following Meltano command:
meltano config target-s3 set max_batch_size [value]Expand To Show SDK Settings
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]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]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]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-brightgreen){kind=icon}
-11,141-c0c0c4){kind=icon}
-106-c0c0c4){kind=icon}
