The tap-brillium extractor pulls data from Brillium 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-brillium extractor to your
project using
:meltano add -
Configure the tap-brillium
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-brilliummeltano config tap-brillium set --interactivemeltano config tap-brillium 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-brillium
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
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-brillium 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-brillium 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_BRILLIUM_API_KEY
The key to authenticate against the API service
Configure this setting directly using the following Meltano command:
meltano config tap-brillium set api_key [value]API Version (api_version)
-
Environment variable:
TAP_BRILLIUM_API_VERSION
Brillium Api Version. Default to latest available
Configure this setting directly using the following Meltano command:
meltano config tap-brillium set api_version [value]Base Uri (base_uri)
-
Environment variable:
TAP_BRILLIUM_BASE_URI
The base url for the API service
Configure this setting directly using the following Meltano command:
meltano config tap-brillium set base_uri [value]Start Date (start_date)
-
Environment variable:
TAP_BRILLIUM_START_DATE
The earliest record date to sync
Configure this setting directly using the following Meltano command:
meltano config tap-brillium set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_BRILLIUM_USER_AGENT
User Agent to use for requests
Configure this setting directly using the following Meltano command:
meltano config tap-brillium 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-brightgreen){kind=icon}
