The tap-anvil extractor pulls data from Anvil 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-anvil extractor to your project
using
:meltano add
-
Configure the tap-anvil settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-anvil
meltano config tap-anvil set --interactive
meltano config tap-anvil 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-anvil
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-anvil
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 config
list
subcommand:
meltano config tap-anvil 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.
Api Key (api_key)
-
Environment variable:
TAP_ANVIL_API_KEY
The API key to use to authenticate against Anvil
Configure this setting directly using the following Meltano command:
meltano config tap-anvil set api_key [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_ANVIL_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-anvil set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_ANVIL_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-anvil set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_ANVIL_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-anvil set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_ANVIL_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-anvil 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.