tap-canvas - Meltano Hub

Canvas

tap-canvas (mwcooley99 variant)🥈

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

meltano add extractor tap-canvas

Configure the tap-canvas settings using

meltano config

:

meltano config tap-canvas set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-canvas 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-canvas 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-canvas 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_key
course_ends_after

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
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-canvas 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 Key (api_key)

Environment variable: TAP_CANVAS_API_KEY

The token to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set api_key [value]

Course Ends After (course_ends_after)

Environment variable: TAP_CANVAS_COURSE_ENDS_AFTER

Limit courses queried to courses that end after this date.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set course_ends_after [value]

Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

Environment variable: TAP_CANVAS_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

Environment variable: TAP_CANVAS_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_CANVAS_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

Environment variable: TAP_CANVAS_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

Environment variable: TAP_CANVAS_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_CANVAS_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-canvas set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

Environment variable: TAP_CANVAS_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-canvas 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-canvas 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-canvas

Maintenance Status

Repo

https://github.com/mwcooley99/tap-canvas

Maintainer

Keywords