The tap-gutendex
extractor
pulls data from
Gutendex 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-gutendex extractor to your
project using
:meltano add -
Configure the tap-gutendex
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-gutendexmeltano config tap-gutendex set --interactivemeltano config tap-gutendex 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-gutendex
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-gutendex 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.author_year_endairbyte_config.author_year_startairbyte_config.copyrightairbyte_config.languagesairbyte_config.searchairbyte_config.sortairbyte_config.topicairbyte_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-gutendex 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.
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_AUTHOR_YEAR_END
(Optional) Defines the maximum birth year of the authors. Books by authors born after the end year will not be returned. Supports both positive (CE) or negative (BCE) integer values
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config author_year_end [value]-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_AUTHOR_YEAR_START
(Optional) Defines the minimum birth year of the authors. Books by authors born prior to the start year will not be returned. Supports both positive (CE) or negative (BCE) integer values
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config author_year_start [value]Airbyte Config Copyright (airbyte_config.copyright)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_COPYRIGHT
(Optional) Use this to find books with a certain copyright status - true for books with existing copyrights, false for books in the public domain in the USA, or null for books with no available copyright information.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config copyright [value]Airbyte Config Languages (airbyte_config.languages)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_LANGUAGES
(Optional) Use this to find books in any of a list of languages. They must be comma-separated, two-character language codes.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config languages [value]Airbyte Config Search (airbyte_config.search)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_SEARCH
(Optional) Use this to search author names and book titles with given words. They must be separated by a space (i.e. %20 in URL-encoded format) and are case-insensitive.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config search [value]Airbyte Config Sort (airbyte_config.sort)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_SORT
(Optional) Use this to sort books - ascending for Project Gutenberg ID numbers from lowest to highest, descending for IDs highest to lowest, or popular (the default) for most popular to least popular by number of downloads.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config sort [value]Airbyte Config Topic (airbyte_config.topic)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_CONFIG_TOPIC
(Optional) Use this to search for a case-insensitive key-phrase in books' bookshelves or subjects.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_config topic [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-gutendex
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_GUTENDEX_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_GUTENDEX_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-gutendex set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_GUTENDEX_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_GUTENDEX_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-gutendex set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_GUTENDEX_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-gutendex set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_GUTENDEX_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-gutendex 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}
