The tap-podbean extractor pulls data from PodBean 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-podbean extractor to your
project using
:meltano add
-
Configure the tap-podbean
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-podbean
meltano config tap-podbean set --interactive
meltano config tap-podbean 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-podbean
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-podbean
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:
client_id
client_secret
start_date
auth_expiration
limit
user_agent
api_url
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-podbean 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.
Client Id (client_id)
-
Environment variable:
TAP_PODBEAN_CLIENT_ID
The client identifier to authenticate against the API service.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set client_id [value]
Client Secret (client_secret)
-
Environment variable:
TAP_PODBEAN_CLIENT_SECRET
The client secret to authenticate against the API service.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set client_secret [value]
Start Date (start_date)
-
Environment variable:
TAP_PODBEAN_START_DATE
The earliest datetime (UTC) to sync records.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set start_date [value]
Auth Expiration (auth_expiration)
-
Environment variable:
TAP_PODBEAN_AUTH_EXPIRATION
Expiraton in seconds for auth. (Range: 60-604800)
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set auth_expiration [value]
Limit (limit)
-
Environment variable:
TAP_PODBEAN_LIMIT
The number of records to return per page. (Range: 0-100)
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set limit [value]
User Agent (user_agent)
-
Environment variable:
TAP_PODBEAN_USER_AGENT
User agent to present to the API.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set user_agent [value]
Api Url (api_url)
-
Environment variable:
TAP_PODBEAN_API_URL
Override the API service base URL.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set api_url [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_PODBEAN_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set stream_maps [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_PODBEAN_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-podbean set stream_map_config [value]
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_PODBEAN_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_PODBEAN_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-podbean 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.