The target-yaml Singer target sends data into YAML after it was pulled from a source using a Singer tap.

Standalone usage #

Install the package using pip: 

pip install git+https://github.com/MeltanoLabs/target-yaml.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific target-yaml instructions to learn more.

Capabilities #

Settings #

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

File Naming Scheme (file_naming_scheme) #

The scheme with which output files will be named. Naming scheme may leverage any of the following substitutions - \n\n- {stream_name}- {datestamp}- {timestamp}

Datestamp Format (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) #

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) #

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) #

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) #

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. \n\nFor example “$.metrics” will populate the file with metrics - [{<record1>},{<record2>},...] \n\nFor JSONPath syntax help, see - https://jsonpath.com

Record Key Property Name (record_key_property_name) #

A property in the record which will be used as the dictionary key.\n\nIf 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) #

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

Overwrite Behavior (overwrite_behavior) #

Determines the overwrite behavior if destination file already exists. Must be one of the following string values - \n\n- append_records (default) - append records at the insertion point\n- replace_records - replace all records at the insertion point\n- replace_file - replace entire file using default_yaml_template\n

Default Yaml Template (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.

Looking for help? #

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