tap-mode - Meltano Hub

Mode

tap-mode (franloza variant)

Data Science Platform

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

meltano add extractor tap-mode

Configure the tap-mode settings using

meltano config

meltano config tap-mode set --interactive

Test that extractor settings are valid using

meltano config

meltano config tap-mode 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-mode 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
discover
state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-mode 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:

auth_token
user_agent
workspace

You can also list these settings using

meltano config

with the list subcommand:

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

Auth Token (auth_token)

Environment variable: TAP_MODE_AUTH_TOKEN

API access token. See how to obtain it from Mode here

Configure this setting directly using the following Meltano command:

meltano config tap-mode set auth_token [value]

User Agent (user_agent)

Environment variable: TAP_MODE_USER_AGENT

The name of your app and a contact email address should the API provider need to contact you for any reason.

Configure this setting directly using the following Meltano command:

meltano config tap-mode set user_agent [value]

Workspace (workspace)

Environment variable: TAP_MODE_WORKSPACE

Name of the Mode workspace

Configure this setting directly using the following Meltano command:

meltano config tap-mode set workspace [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-mode 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-mode

Maintenance Status

Repo

Maintainer

Keywords