YAML

target-yaml from meltanolabs

For loading data into the YAML file format.

The target-yaml loader sends data into YAML 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

Installation and configuration

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

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for target-yaml 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

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The target-yaml 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 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.

File Naming Scheme (file_naming_scheme)

  • Environment variable: TARGET_YAML_FILE_NAMING_SCHEME

The scheme with which output files will be named. Naming scheme may leverage any of the following substitutions:

  • {stream_name}
  • {datestamp}
  • {timestamp}

Datestamp Format (datestamp_format)

  • Environment variable: TARGET_YAML_DATESTAMP_FORMAT

A python format string to use when outputting the {datestamp} string. For reference, see - https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes

Timestamp Format (timestamp_format)

  • Environment variable: TARGET_YAML_TIMESTAMP_FORMAT

A python format string to use when outputting the {datestamp} string. For reference, see - https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes

Timestamp Timezone (timestamp_timezone)

  • Environment variable: TARGET_YAML_TIMESTAMP_TIMEZONE

The timezone code or name to use when generating {timestamp} and {datestamp}. Defaults to "UTC". For a list of possible values, please see -https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Stream Maps (stream_maps)

  • Environment variable: TARGET_YAML_STREAM_MAPS

Allows inline stream transformations and aliasing. For more information see - https://sdk.meltano.com/en/latest/stream_maps.html

Record Insert Jsonpath (record_insert_jsonpath)

  • Environment variable: TARGET_YAML_RECORD_INSERT_JSONPATH

A jsonpath string determining the insertion point for new records. Currently, this must be the path to a map key which will be populated by a list of records. For example "$.metrics" will populate the file with metrics - [{<record1>},{<record2>},...] For JSONPath syntax help, see - https://jsonpath.com

Record Key Property Name (record_key_property_name)

  • Environment variable: TARGET_YAML_RECORD_KEY_PROPERTY_NAME

A property in the record which will be used as the dictionary key. If this property is provided, records will be written as key-value objects; if omitted, records are written as a list.

Record Sort Property Name (record_sort_property_name)

  • Environment variable: TARGET_YAML_RECORD_SORT_PROPERTY_NAME

A property in the record which will be used as a sort key. If this property is omitted, records will not be sorted.

Overwrite Behavior (overwrite_behavior)

  • Environment variable: TARGET_YAML_OVERWRITE_BEHAVIOR

Determines the overwrite behavior if destination file already exists. Must be one of the following string values:

  • append_records (default): append records at the insertion point
  • replace_records: replace all records at the insertion point
  • replace_file: replace entire file using default_yaml_template

Default Yaml Template (default_yaml_template)

  • Environment variable: TARGET_YAML_DEFAULT_YAML_TEMPLATE

Text string to use for a yaml template file. This text will be used to create a new file if the destination file does not exist.

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-yaml 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-yaml

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano Community

Meltano Stats

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

Keywords

  • filemeltano_sdk