The tap-chartmogul
extractor
pulls data from
ChartMogul that can then be
sent to a destination using a loader. ⚠️ Experimental Preview Warning ⚠️
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-chartmogul extractor to your project
using
:meltano add
-
Configure the tap-chartmogul settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-chartmogul
meltano config tap-chartmogul set --interactive
meltano config tap-chartmogul test
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
tap-chartmogul
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:
- catalog
- state
- discover
- 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
tap-chartmogul
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:
airbyte_spec.image
airbyte_spec.tag
docker_mounts
airbyte_config.api_key
airbyte_config.start_date
airbyte_config.interval
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 tap-chartmogul 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.
Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_CHARTMOGUL_AIRBYTE_SPEC_IMAGE
-
Default Value:
airbyte/source-chartmogul
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_CHARTMOGUL_AIRBYTE_SPEC_TAG
-
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_CHARTMOGUL_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set docker_mounts [value]
Airbyte Config Api Key (airbyte_config.api_key)
-
Environment variable:
TAP_CHARTMOGUL_AIRBYTE_CONFIG_API_KEY
Your Chartmogul API key. See the docs for info on how to obtain this.
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set airbyte_config api_key [value]
Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_CHARTMOGUL_AIRBYTE_CONFIG_START_DATE
UTC date and time in the format 2017-01-25T00:00:00Z. When feasible, any data before this date will not be replicated.
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set airbyte_config start_date [value]
Airbyte Config Interval (airbyte_config.interval)
-
Environment variable:
TAP_CHARTMOGUL_AIRBYTE_CONFIG_INTERVAL
Some APIs such as Metrics require intervals to cluster data.
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set airbyte_config interval [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_CHARTMOGUL_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-chartmogul set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_CHARTMOGUL_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-chartmogul set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_CHARTMOGUL_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_CHARTMOGUL_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-chartmogul 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.