GitLab Query Language (GLQL)

GitLab Query Language (GLQL) is a single query language for all of GitLab. Use it to filter and embed content from anywhere in the platform, using familiar syntax.

Embed queries in Markdown code blocks. An embedded view is the rendered output of a GLQL source code block.

Share your feedback in the embedded views, powered by GLQL, feedback issue.

Query syntax

The query syntax consists primarily of logical expressions. These expressions follow the syntax of <field> <operator> <value> and ....

Data sources

GLQL can query different data sources such as work items, merge requests, pipelines, jobs, and projects.

For a full list of supported data sources, see GLQL data sources.

Fields

Use fields to filter, display, and sort results.

The fields you can use depend on the data source you are querying. For a full list of supported fields, operators, and values for each data source, see GLQL fields.

Operators

Comparison operators:

Logical operators: Only and is supported. or is indirectly supported for some fields by using the in comparison operator.

Values

Values can include:

• Strings
• Numbers
• Relative dates (like -1d, 2w, -6m, or 1y)
• Absolute dates (in YYYY-MM-DD format, like 2025-01-01)
• Functions (like currentUser() for user fields or today() for dates)
• Enum values (like upcoming or started for milestones)
• Booleans (true or false)
• Nullable values (like null, none, or any)
• GitLab references (like ~label for a label, %Backlog for a milestone, or @username for a user)
• Lists containing any of the previous values (surrounded by parenthesis: () and delimited by commas: ,)

Embedded views

An embedded view is the output of a GLQL source code block in Markdown. The source includes YAML attributes that describe how to display the GLQL query results, along with the query.

Supported areas

Embedded views can be displayed in the following areas:

• Group and project wikis
• Descriptions and comments of:
  • Epics
  • Issues
  • Merge requests
  • Work items (tasks, OKRs, or epics)
• Repository Markdown files

Syntax

The syntax of an embedded view’s source is a superset of YAML that consists of:

• The query parameter: Expressions joined together with a logical operator, such as and.
• Parameters related to the presentation layer, like display, limit, or fields, title, and description represented as YAML.

A view is defined in Markdown as a code block, similar to other code blocks like Mermaid.

For example:

• Display a table of first 5 open issues assigned to the authenticated user in gitlab-org/gitlab.
• Display columns title, state, health, description, epic, milestone, weight, and updated.

```glql
display: table
title: GLQL table 🎉
description: This view lists my open issues
fields: title, state, health, epic, milestone, weight, updated
limit: 5
query: type = Issue AND group = "gitlab-org" AND assignee = currentUser() AND state = opened
```

This source should render a table like the one below:

Presentation syntax

Aside from the query parameter, you can configure presentation details for your view using some more optional parameters.

Supported parameters:

For example, to display the first five issues assigned to the current user in the gitlab-org/gitlab project as a list, sorted by due date (earliest first) and displaying the title, health, and due fields:

```glql
display: list
fields: title, health, due
limit: 5
sort: due asc
query: type = Issue AND group = "gitlab-org" AND assignee = currentUser() AND state = opened
```

This source should render a list like the one below:

Pagination

Embedded views display the first page of results by default. The limit parameter controls the number of items shown.

To load the next page, in the last row, select Load more.

Field functions

To create dynamically generated columns, use functions in the fields parameters in views. For a full list, see Functions in embedded views.

Custom field aliases

To rename a table view’s column to a custom value, use the AS syntax keyword to alias fields.

```glql
display: list
fields: title, labels("workflow::*") AS "Workflow", labels("priority::*") AS "Priority"
limit: 5
query: type = Issue AND project = "gitlab-org/gitlab" AND assignee = currentUser() AND state = opened
```

This source displays a view with columns Title, Workflow and Priority.

View actions

When a view appears on a page, use the View actions ( ) dropdown list to take an action on it.

Supported actions:

Advanced Search integration

GLQL uses Advanced Search when available to speed up queries. Advanced Search provides faster response times for complex queries across large datasets.

Advanced Search is:

• Enabled by default for GitLab.com and GitLab Dedicated paid subscriptions.
• Available for GitLab Self-Managed when an administrator enables Advanced Search.

If Advanced Search isn’t available, GLQL uses PostgreSQL instead.