The target-timeplus loader sends data into Timeplus after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-timeplus loader to your
project using
:meltano add -
Configure the target-timeplus
settings using
:meltano config
meltano add loader target-timeplusmeltano config target-timeplus set --interactiveNext 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
target-timeplus
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. 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 loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-timeplus 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 target-timeplus 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.
APIkey (apikey)
-
Environment variable:
TARGET_TIMEPLUS_APIKEY
Personal API key
Configure this setting directly using the following Meltano command:
meltano config target-timeplus set apikey [value]Endpoint (endpoint)
-
Environment variable:
TARGET_TIMEPLUS_ENDPOINT -
Default Value:
https://us.timeplus.cloud/wsId1234
Timeplus workspace endpoint
Configure this setting directly using the following Meltano command:
meltano config target-timeplus set endpoint [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_TIMEPLUS_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-timeplus set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_TIMEPLUS_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-timeplus set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_TIMEPLUS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-timeplus set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TARGET_TIMEPLUS_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 target-timeplus set stream_maps [value]Target Authentication and Authorization
You need to create a free account at https://timeplus.com. Sign up with a Google or Microsoft ID, then create a new workspace with a random ID and a friendly name. Then you will be redirected to https://us.timeplus.cloud/wsId1234/console
You need to create an API key to access Timeplus REST API. To do so:
- Click the user icon on the top-right corner.
- Choose Personal Settings
- Choose the 2nd tab API Key Management
- Click the Create API Key button
- Set a readable name and choose an expiration date
- Save the API key securely in your computer. You are not going to retrieve the plain text key again in the console.
For more details, please check https://docs.timeplus.com/docs/quickstart-ingest-api
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-yellow){kind=icon}
