The tap-jaffle-shop extractor pulls data from Jaffle Shop Generator that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-jaffle-shop extractor to your
project using
:meltano add -
Configure the tap-jaffle-shop
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-jaffle-shopmeltano config tap-jaffle-shop set --interactivemeltano config tap-jaffle-shop testNext 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
tap-jaffle-shop
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. 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 extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-jaffle-shop 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 also list these settings using
with the meltano configlist
subcommand:
meltano config tap-jaffle-shop 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.
Stream Name Prefix (stream_name_prefix)
-
Environment variable:
TAP_JAFFLE_SHOP_STREAM_NAME_PREFIX -
Default Value:
tap_jaffle_shop-raw_
A name prefix to apply to all streams. Note that the dash ('-') character will be interpreted by many targets as a delimiter between schema and table name.
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set stream_name_prefix [value]Years (years)
-
Environment variable:
TAP_JAFFLE_SHOP_YEARS -
Default Value:
1
The number of years to simulate data for.
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set years [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_JAFFLE_SHOP_BATCH_CONFIG_ENCODING_COMPRESSION
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_JAFFLE_SHOP_BATCH_CONFIG_ENCODING_FORMAT
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_JAFFLE_SHOP_BATCH_CONFIG_STORAGE_PREFIX
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_JAFFLE_SHOP_BATCH_CONFIG_STORAGE_ROOT
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set batch_config storage.root [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_JAFFLE_SHOP_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_JAFFLE_SHOP_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_JAFFLE_SHOP_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-jaffle-shop set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_JAFFLE_SHOP_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 tap-jaffle-shop set stream_maps [value]This dataset generator will simulate real-looking data for the following streams:
storescustomersproductsordersitemssupplies
You can apply the years config to generate more or less data according to your needs.
Note: This tap supports state but does not yet support incremental refresh. Each sync
operation will generate a new dataset.
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}
-16-c0c0c4){kind=icon}
-10-c0c0c4){kind=icon}
