The tap-the-guardian-api
extractor
pulls data from
The Guardian Api 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-the-guardian-api extractor to your
project using
:meltano add -
Configure the tap-the-guardian-api
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-the-guardian-apimeltano config tap-the-guardian-api set --interactivemeltano config tap-the-guardian-api 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-the-guardian-api
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-the-guardian-api 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.api_keyairbyte_config.end_dateairbyte_config.queryairbyte_config.sectionairbyte_config.start_dateairbyte_config.tagairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-the-guardian-api 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 Api Key (airbyte_config.api_key)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_API_KEY
Your API Key. See here. The key is case sensitive.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config api_key [value]Airbyte Config End Date (airbyte_config.end_date)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_END_DATE
(Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config end_date [value]Airbyte Config Query (airbyte_config.query)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_QUERY
(Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config query [value]Airbyte Config Section (airbyte_config.section)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_SECTION
(Optional) Use this to filter the results by a particular section. See here for a list of all sections, and here for the sections endpoint documentation.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config section [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_START_DATE
Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config start_date [value]Airbyte Config Tag (airbyte_config.tag)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_CONFIG_TAG
(Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See here for a list of all tags, and here for the tags endpoint documentation.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_config tag [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-the-guardian-api
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_THE_GUARDIAN_API_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_THE_GUARDIAN_API_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-the-guardian-api set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_THE_GUARDIAN_API_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_THE_GUARDIAN_API_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-the-guardian-api set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_THE_GUARDIAN_API_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-the-guardian-api set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_THE_GUARDIAN_API_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-the-guardian-api 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-yellow){kind=icon}
