The tap-younium
extractor
pulls data from
Younium that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
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-younium extractor to your
project using
:meltano add
-
Configure the tap-younium
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-younium
meltano config tap-younium set --interactive
meltano config tap-younium 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-younium
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-younium
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_config.legal_entity
airbyte_config.password
airbyte_config.playground
airbyte_config.username
airbyte_spec.image
airbyte_spec.tag
docker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-younium 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 Config Legal Entity (airbyte_config.legal_entity)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_CONFIG_LEGAL_ENTITY
Legal Entity that data should be pulled from
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_config legal_entity [value]
Airbyte Config Password (airbyte_config.password)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_CONFIG_PASSWORD
Account password for younium account API key
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_config password [value]
Airbyte Config Playground (airbyte_config.playground)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_CONFIG_PLAYGROUND
Property defining if connector is used against playground or production environment
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_config playground [value]
Airbyte Config Username (airbyte_config.username)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_CONFIG_USERNAME
Username for Younium account
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_config username [value]
Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_SPEC_IMAGE
-
Default Value:
airbyte/source-younium
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_YOUNIUM_AIRBYTE_SPEC_TAG
-
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-younium set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_YOUNIUM_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-younium set docker_mounts [value]
Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_YOUNIUM_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-younium set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_YOUNIUM_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-younium set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_YOUNIUM_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-younium set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_YOUNIUM_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-younium set stream_maps [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.