The tap-jira
extractor
pulls data from
Jira that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Alternate Implementations
- Airbyte
🥈
- Meltano (default)
- Stitch Data🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-jira extractor to your
project using
:meltano add -
Configure the tap-jira
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-jira --variant airbytemeltano config tap-jira set --interactivemeltano config tap-jira testNext 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-jira
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-jira 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:
airbyte_config.api_tokenairbyte_config.domainairbyte_config.emailairbyte_config.enable_experimental_streamsairbyte_config.expand_issue_changelogairbyte_config.projectsairbyte_config.render_fieldsairbyte_config.start_dateairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-jira 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.
Airbyte Config Api Token (airbyte_config.api_token)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_API_TOKEN
Jira API Token. See the docs for more information on how to generate this key.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config api_token [value]Airbyte Config Domain (airbyte_config.domain)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_DOMAIN
The Domain for your Jira account, e.g. airbyteio.atlassian.net
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config domain [value]Airbyte Config Email (airbyte_config.email)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_EMAIL
The user email for your Jira account.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config email [value]Airbyte Config Enable Experimental Streams (airbyte_config.enable_experimental_streams)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_ENABLE_EXPERIMENTAL_STREAMS
Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config enable_experimental_streams [value]Airbyte Config Expand Issue Changelog (airbyte_config.expand_issue_changelog)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_EXPAND_ISSUE_CHANGELOG
Expand the changelog when replicating issues.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config expand_issue_changelog [value]Airbyte Config Projects (airbyte_config.projects)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_PROJECTS
List of Jira project keys to replicate data for.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config projects [value]Airbyte Config Render Fields (airbyte_config.render_fields)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_RENDER_FIELDS
Render issue fields in HTML format in addition to Jira JSON-like format.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config render_fields [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_JIRA_AIRBYTE_CONFIG_START_DATE
The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. For more information, refer to the documentation.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_config start_date [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_JIRA_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-jira
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_JIRA_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-jira set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_JIRA_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-jira set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_JIRA_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_JIRA_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-jira set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_JIRA_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-jira set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_JIRA_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-jira 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?
#plugins-general-yellow){kind=icon}
-671-c0c0c4){kind=icon}
-4-c0c0c4){kind=icon}
