The tap-babelforce
extractor
pulls data from
Babelforce 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-babelforce extractor to your project
using
:meltano add
-
Configure the tap-babelforce settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-babelforce
meltano config tap-babelforce set --interactive
meltano config tap-babelforce 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-babelforce
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-babelforce
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.region
airbyte_config.access_key_id
airbyte_config.access_token
airbyte_config.date_created_from
airbyte_config.date_created_to
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-babelforce 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_BABELFORCE_AIRBYTE_SPEC_IMAGE
-
Default Value:
airbyte/source-babelforce
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_SPEC_TAG
-
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_BABELFORCE_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-babelforce set docker_mounts [value]
Airbyte Config Region (airbyte_config.region)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_CONFIG_REGION
Babelforce region
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_config region [value]
Airbyte Config Access Key Id (airbyte_config.access_key_id)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_CONFIG_ACCESS_KEY_ID
The Babelforce access key ID
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_config access_key_id [value]
Airbyte Config Access Token (airbyte_config.access_token)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_CONFIG_ACCESS_TOKEN
The Babelforce access token
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_config access_token [value]
Airbyte Config Date Created From (airbyte_config.date_created_from)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_CONFIG_DATE_CREATED_FROM
Timestamp in Unix the replication from Babelforce API will start from. For example 1651363200 which corresponds to 2022-05-01 00:00:00.
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_config date_created_from [value]
Airbyte Config Date Created To (airbyte_config.date_created_to)
-
Environment variable:
TAP_BABELFORCE_AIRBYTE_CONFIG_DATE_CREATED_TO
Timestamp in Unix the replication from Babelforce will be up to. For example 1651363200 which corresponds to 2022-05-01 00:00:00.
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set airbyte_config date_created_to [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_BABELFORCE_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-babelforce set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_BABELFORCE_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-babelforce set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_BABELFORCE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_BABELFORCE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-babelforce 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.