User Guide > About the User Guide > Codebeamer: Common Concepts > Searching > Introduction to cbQL > cbQL Structure
cbQL Structure
cbQL (Codebeamer Query Language) enables you to retrieve and organize tracker items using structured query keywords. Each keyword controls a specific aspect of the query result: what data to display, how to filter it, how to group it, and how to sort it.
A cbQL query is composed of the following keywords:
Keywords
Required
Description
SELECT
Optional
Defines the fields to display in the query results. You can include aggregation functions, filters, or field alias names.
WHERE
Required if SELECT is used
Specifies the conditions that filter tracker items.
GROUP BY
Optional
Groups the filtered results by a specified field or alias.
ORDER BY
Optional
Sorts the results by one or more fields in ascending (ASC) or descending (DESC) order.
Example
SELECT assignedTo as 'Assigned to' WHERE storyPoints > 2 GROUP BY assignedTo ORDER BY summary DESC
The following table describes the effect of each Keyword in this example:
Keyword
Effect
SELECT assignedTo AS 'Assigned to'
Displays the assignedTo field with the column label Assigned to.
WHERE storyPoints > 2
Returns only tracker items where the storyPoints value is greater than 2.
GROUP BY assignedTo
Groups the returned items by the assignedTo field.
ORDER BY summary DESC
Sorts the grouped results by the summary field in descending order.
Was this helpful?