The tap-recurly extractor pulls data from Recurly that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-recurly extractor to your
project using
:meltano add -
Configure the tap-recurly
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-recurlymeltano config tap-recurly set --interactivemeltano config tap-recurly 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-recurly
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
tap-recurly 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-recurly 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_RECURLY_API_KEY
Your Recurly API key. See the API docs for details on getting a key.
Configure this setting directly using the following Meltano command:
meltano config tap-recurly set api_key [value]Quota Limit (quota_limit)
-
Environment variable:
TAP_RECURLY_QUOTA_LIMIT
The percentage of the rate limit dedicated to the tap. Default, 100.
Configure this setting directly using the following Meltano command:
meltano config tap-recurly set quota_limit [value]Start Date (start_date)
-
Environment variable:
TAP_RECURLY_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-recurly set start_date [value]Subdomain (subdomain)
-
Environment variable:
TAP_RECURLY_SUBDOMAIN
Your Recurly subdomain.
Configure this setting directly using the following Meltano command:
meltano config tap-recurly set subdomain [value]User Agent (user_agent)
-
Environment variable:
TAP_RECURLY_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-recurly set user_agent [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
