# GitLab (v1) Information note **GitLab is supported by the Singer community** This integration is powered by [Singer's](https://www.singer.io/) GitLab tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-gitlab) or [join the Singer Slack](https://singer-slackin.herokuapp.com/). ## GitLab integration summary Stitch’s GitLab integration replicates data using the [GitLab REST API](https://docs.gitlab.com/ee/api/README.html). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#schema) section for a list of objects available for replication. ## GitLab feature snapshot A high-level look at Stitch's GitLab (v1) integration, including release status, useful links, and the features supported in Stitch. | **STITCH** | | | | | --- | --- | --- | --- | | **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on March 1, 2017 | **Supported by**

the Info icon

Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) | | **Stitch plan**

the Info icon

The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**

the Info icon

Indicates if the integration is available as a source in Stitch Connect. | the Success icon

This version of the integration is available via the API.


Available | | **Singer GitHub repository** | [singer-io/tap-gitlab](https://github.com/singer-io/tap-gitlab) | | | | **REPLICATION SETTINGS** | | | | | **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**

the Info icon

A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**

the Info icon

A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Table-level reset**

the Info icon

Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon

Table-level resets are not supported for this integration. Resets are only supported at the integration level.


Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**

the Info icon

Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon

Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.


Unsupported | | **DATA SELECTION** | | | | | **Table selection**

the Info icon

The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | **Column selection**

the Info icon

The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon

This feature is supported for this version of the integration.


Supported | | **Select all**

the Info icon

Indicates if the integration supports selecting all available tables and columns. | the Success icon

Supported


Supported | | | | **TRANSPARENCY** | | | | | **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**

the Info icon

Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**

the Info icon

Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon

This feature is supported for this version of the integration.


Supported | ## Connecting GitLab ### GitLab setup requirements To set up GitLab in Stitch, you need: * **Access to any projects you want to replicate data from.** Stitch will only be able to access the same projects as the user who creates the integration. ### Step 1: Create a GitLab token 1. Sign into your GitLab account. 2. Click the **user menu (your icon) > Settings**. 3. Click the **Access Tokens** tab. 4. In the **Name** field, enter `Stitch`. This will allow you to easily identify what application is using the token. 5. In the **Scopes** section, check the **api** box. This will allow Stitch to access your API and replicate your GitLab data. 6. Click **Create Personal Access Token**. 7. The new Access Token will display at the top of the page. **Copy the token before navigating away from the page** - GitLab won’t display it again. ### Step 2: Add GitLab as a Stitch data source 1. [Sign into your Stitch account](https://app.stitchdata.com/). 2. On the Stitch Dashboard page, click the **Add Integration** button. 3. Click the **GitLab** icon. 4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination. For example, the name “Stitch GitLab” would create a schema called `stitch_gitlab` in the destination. **Note**: Schema names cannot be changed after you save the integration. 5. In the **API URL** field, enter `https://gitlab.com/api/v4`. 6. In the **Private Token** field, paste the **Personal Access Token** you created in the previous section. 7. In the **Projects** and **Groups to Track** fields, you’ll enter the projects and/or groups you want to track as a **space-separated** list. For example: `stitchdata/group-a`, or `stitchdata/project-a stitchdata/project-b` **Note**: A value for one of these fields must be provided. Additionally, the way you define these settings determines how some data is replicated: * If **groups** are provided but **projects** aren’t, all group projects will be replicated. * If **groups** and **projects** are provided, the selected projects of the listed groups will be replicated. * If **projects** are provided but **groups** aren’t, all listed projects will be replicated. ### Step 3: Define the historical replication start date The Sync Historical Data setting defines the starting date for your GitLab integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse. Change this setting if you want to replicate data beyond GitLab’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide. ### Step 4: Create a replication schedule Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information. In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins. GitLab integrations support the following replication scheduling methods: * [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency) * [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling) * [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only) To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage. ### Step 5: Set objects to replicate Information note **Is an object missing or not replicating?** Verify that the object meets the requirements for [selection](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#selection-requirements) and [replication](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#replication-requirements). The last step is to select the tables and columns you want to replicate. [Learn about the available tables for this integration.](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#schema) **Note**: If a replication job is currently in progress, new selections won’t be used until the next job starts. * Selection options * Individual tables and columns * All tables and columns For GitLab integrations, you can select: 1. **Individual tables and columns** 2. **All tables and columns** Click the tabs to view instructions for each selection method. 1. In the integration’s **Tables to Replicate tab**, locate a table you want to replicate. 2. To track a table, click the **checkbox** next to the table’s name. A blue checkmark means the table is set to replicate. 3. To track a column, click the **checkbox** next to the column’s name. A blue checkmark means the column is set to replicate. 4. Repeat this process for all the tables and columns you want to replicate. 5. When finished, click the **Finalize Your Selections** button at the bottom of the screen to save your selections. Information note **Important**: Using the **Select All** feature will overwrite any previous selections. However, selections aren’t final until **Finalize Your Selections** is clicked. Clicking **Cancel** will restore your previous selections. Refer to the [Select All guide](https://help.qlik.com/en-US/stitch/replication/extractions/data-selection/setting-tables-and-columns-to-replicate#set-all-data-to-replicate) for more info about this feature. 1. Click into the integration from the Stitch Dashboard page. 2. Click the **Tables to Replicate** tab. 3. In the list of tables, click the box next to the **Table Names** column. 4. In the menu that displays, click **Track all Tables and Fields**: ![The Track all Tables and Fields menu in the Tables to Replicate tab](https://help.qlik.com/en-US/stitch/images/replication/select-all-tables-menu.png)The Track all Tables and Fields menu in the Tables to Replicate tabThe Track all Tables and Fields menu in the Tables to Replicate tab 5. Click the **Finalize Your Selections** button at the bottom of the page to save your data selections. ### Initial and historical replication jobs After you finish setting up GitLab, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page. For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.** Information note **Initial replication jobs with Anchor Scheduling** If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information. #### Free historical data loads The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota. Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage. ## GitLab table reference Information note **Schemas and versioning** Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing. The schema and info displayed below is for **version 1** of this integration. This is the latest version of the GitLab integration. Information note **Table and column names in your destination** Depending on your destination, table and column names may not appear as they are outlined below. For example: Object names are lowercased in Redshift (`CusTomERs` > `customers`), while case is maintained in PostgreSQL destinations (`CusTomERs` > `CusTomERs`). Refer to the [Loading Guide](https://help.qlik.com/en-US/stitch/replication/loading/destination-guides) for your destination for more info. ### branches The `branches` table contains high-level info about repository branches in your projects. **Note**: To replicate branch data, you must set this table and the [`projects`](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) table to replicate. Data for this table will only be replicated when the associated project (in the [`projects`](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) table) is also updated. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Keys ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | project\_id

name | | **Useful links** | [branches schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/branches.json "Opens in new tab: branches schema on GitHub")


[GitLab API method](https://gitlab.com/help/api/branches.html#list-repository-branches "Opens in new tab: GitLab API method") | branches table foreign keys | Join branches with | on | | --- | --- | | [commits](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#commits) | ```
branches.project_id = commits.project_id
```

```
branches.commit_id = commits.id
``` | | [issues](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#issues) | ```
branches.project_id = issues.project_id
``` | | [milestones](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#milestones) | ```
branches.project_id = milestones.project_id
``` | | [projects](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) | ```
branches.project_id = projects.project_id
``` | branches table schema | **commit\_id**


STRING | | --- | | **developers\_can\_merge**


BOOLEAN | | **developers\_can\_push**


BOOLEAN | | **merged**


BOOLEAN | | **name**


STRING | | **project\_id**


INTEGER | | **protected**


BOOLEAN | ### commits The `commits` table contains info about repository commits in a project. **Note**: To replicate commit data, you must set this table and the [`projects`](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) table to replicate. Data for this table will only be replicated when the associated project (in the [`projects`](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) table) is also updated. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [commits schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/commits.json "Opens in new tab: commits schema on GitHub")


[GitLab API method](https://gitlab.com/help/api/commits.md#list-repository-commits "Opens in new tab: GitLab API method") | commits table foreign keys | Join commits with | on | | --- | --- | | [branches](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#branches) | ```
commits.project_id = branches.project_id
```

```
commits.id = branches.commit_id
``` | | [issues](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#issues) | ```
commits.project_id = issues.project_id
``` | | [milestones](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#milestones) | ```
commits.project_id = milestones.project_id
``` | | [projects](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) | ```
commits.project_id = projects.project_id
``` | commits table schema | **allow\_failure**


BOOLEAN | | --- | | **author\_email**


STRING | | **author\_name**


STRING | | **committer\_email**


STRING | | **committer\_name**


STRING | | **created\_at**


DATE-TIME | | **id**


STRING | | **message**


STRING | | **project\_id**


INTEGER | | **short\_id**


STRING | | **title**


STRING | ### groups The `groups` table contains info about the groups in your GitLab account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [groups schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/users.json "Opens in new tab: groups schema on GitHub")


[GitLab API method](https://docs.gitlab.com/ee/api/groups.html#list-groups "Opens in new tab: GitLab API method") | groups table schema | **avatar\_url**


STRING | | --- | | **description**


STRING | | **full\_name**


STRING | | **full\_path**


STRING | | **id**


INTEGER | | **lfs\_enabled**


BOOLEAN | | **name**


STRING | | **path**


STRING | | **projects**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand projects

id

INTEGER

| | **request\_access\_enabled**


BOOLEAN | | **visibility\_level**


INTEGER | | **web\_url**


STRING | ### issues The `issues` table contains info about issues contained within projects. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | updated\_at | | **Useful links** | [issues schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/issues.json "Opens in new tab: issues schema on GitHub")


[GitLab API method](https://gitlab.com/help/api/issues.md#list-project-issues "Opens in new tab: GitLab API method") | issues table foreign keys | Join issues with | on | | --- | --- | | [branches](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#branches) | ```
issues.project_id = branches.project_id
``` | | [commits](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#commits) | ```
issues.project_id = commits.project_id
``` | | [milestones](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#milestones) | ```
issues.project_id = milestones.project_id
```

```
issues.milestone_id = milestones.id
``` | | [projects](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) | ```
issues.project_id = projects.project_id
``` | issues table schema | **assignee\_id**


INTEGER | | --- | | **author\_id**


INTEGER | | **confidential**


BOOLEAN | | **created\_at**

DATE-TIME | | **description**


STRING | | **due\_date**


STRING | | **id**


INTEGER | | **iid**


INTEGER | | **labels**


ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **milestone\_id**


INTEGER | | **project\_id**


INTEGER | | **state**


STRING | | **subscribed**


BOOLEAN | | **title**


STRING | | **updated\_at**

DATE-TIME | | **user\_notes\_count**


INTEGER | | **web\_url**


STRING | ### projects The `projects` table contains info about specific projects. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Key-based Incremental | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Replication Key ![](https://help.qlik.com/en-US/stitch/images/replication/replication-key-icon.svg)** | last\_activity\_at | | **Useful links** | [projects schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/projects.json "Opens in new tab: projects schema on GitHub")


[GitLab API method](https://gitlab.com/help/api/projects.md#list-all-projects "Opens in new tab: GitLab API method") | projects table foreign keys | Join projects with | on | | --- | --- | | [branches](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#branches) | ```
projects.project_id = branches.project_id
``` | | [commits](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#commits) | ```
projects.project_id = commits.project_id
``` | | [issues](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#issues) | ```
projects.project_id = issues.project_id
``` | | [milestones](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#milestones) | ```
projects.project_id = milestones.project_id
``` | | [users](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#users) | ```
projects.creator_id = users.id
``` | projects table schema | **approvals\_before\_merge**


INTEGER | | --- | | **archived**


BOOLEAN | | **avatar\_url**


STRING | | **builds\_enabled**


BOOLEAN | | **container\_registry\_enabled**


BOOLEAN | | **created\_at**

DATE-TIME | | **creator\_id**


INTEGER | | **default\_branch**


STRING | | **description**


STRING | | **forks\_count**


INTEGER | | **http\_url\_to\_repo**


STRING | | **id**


INTEGER | | **issues\_enabled**


BOOLEAN | | **last\_activity\_at**

DATE-TIME | | **lfs\_enabled**


BOOLEAN | | **merge\_requests\_enabled**


BOOLEAN | | **name**


STRING | | **name\_with\_namespace**


STRING | | **namespace**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand namespace

id

INTEGER

kind

STRING

name

STRING

path

STRING

| | **only\_allow\_merge\_if\_all\_discussions\_are\_resolved**


BOOLEAN | | **only\_allow\_merge\_if\_build\_succeeds**


BOOLEAN | | **open\_issues\_count**


INTEGER | | **owner\_id**


INTEGER | | **path**


STRING | | **path\_with\_namespace**


STRING | | **permissions**


OBJECT

This is a nested data structure. If your destination doesn't natively support nested data, attributes in this object will be flattened into the table. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand permissions

group_access

OBJECT

project_access

OBJECT

| | **public**


BOOLEAN | | **public\_builds**


BOOLEAN | | **request\_access\_enabled**


BOOLEAN | | **shared\_runners\_enabled**


BOOLEAN | | **shared\_with\_groups**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>.

Click to expand shared\_with\_groups

group_access_level

INTEGER

group_id

INTEGER

group_name

STRING

| | **snippets\_enabled**


BOOLEAN | | **ssh\_url\_to\_repo**


STRING | | **star\_count**


INTEGER | | **tag\_list**

ARRAY

This is a nested data structure. If your destination doesn't natively support nested data, attributes will be denested into a subtable. <a href='/en-US/stitch/replication/loading/understanding-loading-row-usage-for-nested-data-structures' target='new'>Learn more</a>. | | **visibility\_level**


INTEGER | | **web\_url**


STRING | | **wiki\_enabled**


BOOLEAN | ### users The `users` table contains info about the users in your GitLab account. | **Replication Method [](https://help.qlik.com/en-US/stitch/replication/replication-methods)[the Info icon](https://help.qlik.com/en-US/stitch/replication/replication-methods)[](https://help.qlik.com/en-US/stitch/replication/replication-methods)** | Full Table | | --- | --- | | **Primary Key ![](https://help.qlik.com/en-US/stitch/images/replication/primary-key-icon.svg)** | id | | **Useful links** | [users schema on GitHub](https://github.com/singer-io/tap-gitlab/blob/master/tap_gitlab/schemas/users.json "Opens in new tab: users schema on GitHub")


[GitLab API method](https://gitlab.com/help/api/users.md#list-users "Opens in new tab: GitLab API method") | users table foreign keys | Join users with | on | | --- | --- | | [projects](https://help.qlik.com/en-US/stitch/integrations/saas/gitlab#projects) | ```
users.id = projects.creator_id
``` | users table schema | **avatar\_url**


STRING | | --- | | **id**


INTEGER | | **name**


STRING | | **state**


STRING | | **username**


STRING | | **web\_url**


STRING |