The tap-gitlab extractor pulls data from GitLab that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-gitlab extractor to your
project using
:meltano add
-
Configure the tap-gitlab
settings using
:meltano config
-
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-gitlab --variant meltano
meltano config tap-gitlab set --interactive
meltano config tap-gitlab 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-gitlab
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-gitlab
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
fetch_merge_request_commits
fetch_pipelines_extended
groups
private_token
projects
start_date
ultimate_license
You can also list these settings using
with the meltano config
list
subcommand:
meltano config tap-gitlab 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.
GitLab Instance (api_url)
-
Environment variable:
TAP_GITLAB_API_URL
-
Default Value:
https://gitlab.com
GitLab API/instance URL. When an API path is omitted, /api/v4/
is assumed.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set api_url [value]
(fetch_merge_request_commits)
-
Environment variable:
TAP_GITLAB_FETCH_MERGE_REQUEST_COMMITS
-
Default Value:
false
For each Merge Request, also fetch the MR's commits and create the join table merge_request_commits
with the Merge Request and related Commit IDs. This can slow down extraction considerably because of the many API calls required.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set fetch_merge_request_commits [value]
(fetch_pipelines_extended)
-
Environment variable:
TAP_GITLAB_FETCH_PIPELINES_EXTENDED
-
Default Value:
false
For every Pipeline, also fetch extended details of each of these pipelines. This can slow down extraction considerably because of the many API calls required.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set fetch_pipelines_extended [value]
Groups (groups)
-
Environment variable:
TAP_GITLAB_GROUPS
Space-separated names of groups to extract data from. Leave empty and provide a project name if you'd like to pull data from a project in a personal user namespace.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set groups [value]
Access Token (private_token)
-
Environment variable:
TAP_GITLAB_PRIVATE_TOKEN
GitLab personal access token or other API token.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set private_token [value]
Project (projects)
-
Environment variable:
TAP_GITLAB_PROJECTS
Space-separated namespace/project
paths of projects to extract data from. Leave empty and provide a group name to extract data from all group projects.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set projects [value]
(start_date)
-
Environment variable:
TAP_GITLAB_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set start_date [value]
(ultimate_license)
-
Environment variable:
TAP_GITLAB_ULTIMATE_LICENSE
-
Default Value:
false
Enable to pull in extra data (like Epics, Epic Issues and other entities) only available to GitLab Ultimate and GitLab.com Gold accounts.
Configure this setting directly using the following Meltano command:
meltano config tap-gitlab set ultimate_license [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
channel.