• Supported areas
  • Supported objects to query
• Syntax
  • Query syntax
    • Query shorthand syntax
  • Presentation syntax
    • Field functions
      • labels
• Known issues

GitLab Query Language (GLQL)

GitLab Query Language (GLQL) is an experimental attempt to create 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.

This feature is an experiment. To test it:

• On GitLab self-managed, ask your administrator to enable the glql_integration feature flag on your instance.
• On GitLab.com, contact your account representative.

Share your feedback in epic 14939, either as a comment on the epic, or by creating a new issue under the epic with labels ~"group::knowledge" and ~"type::feature" or ~"type::bug".

Supported areas

GLQL blocks are rendered in the following areas:

• Wikis (group and project)
• Epics and epic comments
• Issue and issue comments
• Merge requests and merge request comments
• Work items (tasks, OKRs, epics with the new look) and work item comments

Supported objects to query

GLQL can only query issues under a project or group.

Syntax

The syntax of GLQL 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, fields.

A GLQL block 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
fields: title, state, health, epic, milestone, weight, updated
limit: 5
query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND opened = true
```

This query should render a table like the one below:

Query syntax

GLQL syntax consists primarily of logical expressions. These expressions follow the syntax of <field name> [< | > | = | != | in] <value> [AND] ....

Field names include assignee, author, label, and milestone. For a full list of supported fields, see the table at the bottom of this section.

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
• Dates (relative or absolute)
• Functions (like currentUser() for assignee or today() for dates)
• Special tokens (like upcoming or started for milestones)

The following table lists all supported fields and their value types:

Query shorthand syntax

When querying multiple labels and assignees, you can also use the shorthand syntax to simplify the query.

For example:

Presentation syntax

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

Three parameters are supported:

Supported fields to display:

• assignees
• author
• closed
• created
• description
• due
• health
• iteration
• cadence
• labels
• milestone
• state
• title
• type
• updated
• weight

For example:

Display first five issues assigned to current user in the gitlab-org/gitlab project as a list, displaying fields title, health, and due.

```glql
---
display: list
fields: title, health, due
limit: 5
---
project = "gitlab-org/gitlab" AND assignee = currentUser() AND opened = true
```

Field functions

In the fields parameter, you can also include functions to derive a column from an existing field.

In the initial version, only the labels function is supported.

labels

• Syntax: labels("field1", "field2")

• Description: The labels function takes one or more label name string values as parameter, and creates a filtered column with only those labels on issues. The function also works as an extractor, so if a label has been extracted, it no longer shows up in the regular labels column, if you choose to display that column as well.

  By default, this function looks for an exact match to the label name. You can include * in the string to match one or more wildcard characters.

  The label names you pass are case-insensitive, so Deliverable and deliverable are equivalent.

• Limits: A minimum of 1 and maximum of 100 label names can be passed to the labels function.

• Usage examples:

  • labels("workflow::*"): Include all workflow scoped labels in the column.
  • labels("Deliverable", "Stretch", "Spike"): Include labels Deliverable, Stretch, and Spike.
  • labels("*end"): Include all labels like backend, frontend, and others that end with end.

  To include the function in the query, follow this example:

  ```glql
  display: list
  fields: title, health, due, labels("workflow::*"), labels
  limit: 5
  query: project = "gitlab-org/gitlab" AND assignee = currentUser() AND opened = true
  ```
  

Known issues

For a full list of known issues, see epic 14437 “GitLab Query Language (GLQL) Strategy”.