tap-meshstack - Meltano Hub

Meshstack

tap-meshstack (meshcloud variant)🥈

The tap-meshstack extractor pulls data from Meshstack 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-meshstack extractor to your project using
```
meltano add
```
:

meltano add extractor tap-meshstack

Configure the tap-meshstack settings using

meltano config

:

meltano config tap-meshstack set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-meshstack 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-meshstack 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
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-meshstack 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:

cert_path
federation.api_url
federation.auth.password
federation.auth.username
kraken.api_url
kraken.auth.password
kraken.auth.username

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-meshstack 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.

Cert Path (cert_path)

Environment variable: TAP_MESHSTACK_CERT_PATH

Path to a public SSL certificate used to verify connection to meshStack

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set cert_path [value]

Federation API URL (federation.api_url)

Environment variable: TAP_MESHSTACK_FEDERATION_API_URL

The url of the meshObject API (excluding the /api prefix!)

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set federation api_url [value]

Federation Auth Password (federation.auth.password)

Environment variable: TAP_MESHSTACK_FEDERATION_AUTH_PASSWORD

The HTTP basic auth password to authenticate against the meshObject API for federation

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set federation auth.password [value]

Federation Auth Username (federation.auth.username)

Environment variable: TAP_MESHSTACK_FEDERATION_AUTH_USERNAME

The HTTP basic auth user to authenticate against the meshObject API for federation

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set federation auth.username [value]

Kraken API URL (kraken.api_url)

Environment variable: TAP_MESHSTACK_KRAKEN_API_URL

The url of the meshObject API (excluding the /api prefix!)

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set kraken api_url [value]

Kraken Auth Password (kraken.auth.password)

Environment variable: TAP_MESHSTACK_KRAKEN_AUTH_PASSWORD

The HTTP basic auth password to authenticate against the meshObject API for kraken

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set kraken auth.password [value]

Kraken Auth Username (kraken.auth.username)

Environment variable: TAP_MESHSTACK_KRAKEN_AUTH_USERNAME

The HTTP basic auth user to authenticate against the meshObject API for kraken

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set kraken auth.username [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_MESHSTACK_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_MESHSTACK_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_MESHSTACK_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-meshstack set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_MESHSTACK_STREAM_MAPS

Config object for stream maps capability.

Configure this setting directly using the following Meltano command:

meltano config tap-meshstack set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-meshstack extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-meshstack

Maintenance Status

Repo

https://github.com/meshcloud/tap-meshstack

Maintainer

Keywords