The tap-holidays extractor pulls data from Holiday API 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-holidays extractor to your
project using
:meltano add -
Configure the tap-holidays
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-holidaysmeltano config tap-holidays set --interactivemeltano config tap-holidays 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-holidays
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
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The streams.holidays.<> configurations have additional optional request parameters that can be set, see the API docs for more details. For example, meltano config tap-holidays set streams.holidays.public True will retrieve only public holidays. Also be aware that currently the free tier includes only last year holidays.
The
tap-holidays 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 configlist
subcommand:
meltano config tap-holidays 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_HOLIDAYS_API_KEY
A valid Holiday API key.
Configure this setting directly using the following Meltano command:
meltano config tap-holidays set api_key [value]API Version (api_version)
-
Environment variable:
TAP_HOLIDAYS_API_VERSION -
Default Value:
v1
The API version to use, default v1.
Configure this setting directly using the following Meltano command:
meltano config tap-holidays set api_version [value]Country Code - Holiday Streams (streams.holidays.country)
-
Environment variable:
TAP_HOLIDAYS_STREAMS_HOLIDAYS_COUNTRY
The country code to request holidays for.
Configure this setting directly using the following Meltano command:
meltano config tap-holidays set streams holidays.country [value]Year - Holiday Streams (streams.holidays.year)
-
Environment variable:
TAP_HOLIDAYS_STREAMS_HOLIDAYS_YEAR
The year to request holidays for.
Configure this setting directly using the following Meltano command:
meltano config tap-holidays set streams holidays.year [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
-1-c0c0c4){kind=icon}
