The tap-tvsquared extractor pulls data from TVSquared 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-tvsquared extractor to your project
using
:meltano add
-
Configure the tap-tvsquared settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-tvsquared
meltano config tap-tvsquared set --interactive
meltano config tap-tvsquared 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-tvsquared
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
- state
- discover
- about
- stream-maps
- schema-flattening
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
tap-tvsquared
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:
partner_domain
api_number
username
password
start_date
stream_maps
stream_map_config
flattening_enabled
flattening_max_depth
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-tvsquared 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.
Partner Domain (partner_domain)
-
Environment variable:
TAP_TVSQUARED_PARTNER_DOMAIN
Partner domain for your TVSquared account
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set partner_domain [value]
Api Number (api_number)
-
Environment variable:
TAP_TVSQUARED_API_NUMBER
Number for your account API, i.e. https://api-xx.tvsquared.com
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set api_number [value]
Username (username)
-
Environment variable:
TAP_TVSQUARED_USERNAME
Username for authentication
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set username [value]
Password (password)
-
Environment variable:
TAP_TVSQUARED_PASSWORD
Password for authentication
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set password [value]
Start Date (start_date)
-
Environment variable:
TAP_TVSQUARED_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-tvsquared set start_date [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_TVSQUARED_STREAM_MAPS
Config object for stream maps capability.
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_TVSQUARED_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-tvsquared set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_TVSQUARED_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_TVSQUARED_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-tvsquared set flattening_max_depth [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.