The tap-suger extractor pulls data from Suger 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-suger extractor to your
project using
:meltano add -
Configure the tap-suger
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-sugermeltano config tap-suger set --interactivemeltano config tap-suger 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-suger
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
- batch
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-suger 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:
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-suger 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.
OAuth Client ID (client_id)
-
Environment variable:
TAP_SUGER_CLIENT_ID
Suger OAuth App client id (API keys are deprecated). Create an OAuth App at https://console.suger.io/settings?tab=api_client
Configure this setting directly using the following Meltano command:
meltano config tap-suger set client_id [value]OAuth Client Secret (client_secret)
-
Environment variable:
TAP_SUGER_CLIENT_SECRET
Suger OAuth App client secret (shown only once at creation).
Configure this setting directly using the following Meltano command:
meltano config tap-suger set client_secret [value]Organization ID (organization_id)
-
Environment variable:
TAP_SUGER_ORGANIZATION_ID
Suger organization id that requests are scoped to.
Configure this setting directly using the following Meltano command:
meltano config tap-suger set organization_id [value]API URL (api_url)
-
Environment variable:
TAP_SUGER_API_URL -
Default Value:
https://api.suger.cloud
Base URL for the Suger API (also the OAuth token audience).
Configure this setting directly using the following Meltano command:
meltano config tap-suger set api_url [value]OAuth Token URL (token_url)
-
Environment variable:
TAP_SUGER_TOKEN_URL -
Default Value:
https://apiv2.suger.cloud/oauth2/token
OAuth 2.0 client-credentials token endpoint.
Configure this setting directly using the following Meltano command:
meltano config tap-suger set token_url [value]Start Date (start_date)
-
Environment variable:
TAP_SUGER_START_DATE
Earliest record datetime to sync (ISO 8601).
Configure this setting directly using the following Meltano command:
meltano config tap-suger set start_date [value]Expand To Show SDK Settings
Stream Maps (stream_maps)
-
Environment variable:
TAP_SUGER_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-suger set stream_maps [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_SUGER_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-suger set stream_map_config [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_SUGER_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-suger set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_SUGER_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-suger 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-brightgreen){kind=icon}
