tap-gladly - Meltano Hub

Gladly

tap-gladly (harrystech variant)🥈

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

meltano add extractor tap-gladly

Configure the tap-gladly settings using

meltano config

:

meltano config tap-gladly set --interactive

Test that extractor settings are valid using

meltano config

:

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

api_url_base
end_date
max_job_lookback
password
project_ids
start_date
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-gladly 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.

API URL Base (api_url_base)

Environment variable: TAP_GLADLY_API_URL_BASE

The url for the API service

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set api_url_base [value]

End Date (end_date)

Environment variable: TAP_GLADLY_END_DATE

The latest job date to sync, parsed with "pendulum.parse"

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set end_date [value]

Max Job Lookback (max_job_lookback)

Environment variable: TAP_GLADLY_MAX_JOB_LOOKBACK

Maximmum lookback in time to try fetch files generated by export jobs from. If start_date is earlier than (now - start_date), the tap does not try to fetch the export files as it assumes they do not exist.

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set max_job_lookback [value]

Password (password)

Environment variable: TAP_GLADLY_PASSWORD

The username to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set password [value]

Project IDs (project_ids)

Environment variable: TAP_GLADLY_PROJECT_IDS

Project IDs to replicate

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set project_ids [value]

Start Date (start_date)

Environment variable: TAP_GLADLY_START_DATE

The earliest job date to sync, parsed with "pendulum.parse"

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set start_date [value]

Username (username)

Environment variable: TAP_GLADLY_USERNAME

The username to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set username [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_GLADLY_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_GLADLY_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-gladly set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

Environment variable: TAP_GLADLY_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-gladly 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-gladly 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-gladly

Maintenance Status

Repo

https://github.com/harrystech/tap-gladly

Maintainer

Meltano Stats

Keywords