The tap-redash extractor pulls data from Redash 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-redash extractor to your
project using
:meltano add
-
Configure the tap-redash
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-redash
meltano config tap-redash set --interactive
meltano config tap-redash test
Next 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-redash
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:
- discover
- properties
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-redash
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 config
list
subcommand:
meltano config tap-redash 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_REDASH_API_KEY
Your API key.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set API_KEY [value]
Login Url (LOGIN_URL)
-
Environment variable:
TAP_REDASH_LOGIN_URL
Your login url. E.g. https://reports.replace-with-org-name.com/login.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set LOGIN_URL [value]
Query Id (QUERY_ID)
-
Environment variable:
TAP_REDASH_QUERY_ID
Your query ID.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set QUERY_ID [value]
Query URL (QUERY_URL)
-
Environment variable:
TAP_REDASH_QUERY_URL
The query url to use. E.g. https://reports.replace-with-org-name.com/api/queries
Configure this setting directly using the following Meltano command:
meltano config tap-redash set QUERY_URL [value]
Disable Collection (disable_collection)
-
Environment variable:
TAP_REDASH_DISABLE_COLLECTION
Whether to allow annoymous usage tracking. Default, true.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set disable_collection [value]
Email (email)
-
Environment variable:
TAP_REDASH_EMAIL
Your Redash email.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set email [value]
Password (password)
-
Environment variable:
TAP_REDASH_PASSWORD
Your password.
Configure this setting directly using the following Meltano command:
meltano config tap-redash set password [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
channel.