wiki:TracQuery

Version 2 (modified by trac, 13 years ago) (diff)

--

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page the default filters will display all open tickets, or if you're logged in it will display open tickets assigned to you. Current filters can be removed by clicking the button to the right with the minus sign on the label. New filters are added from the pulldown list in the bottom-right corner of the filters box. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an or of the criteria.

You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

Once you've edited your filters click the Update button to refresh your results.

Clicking on one of the query results will take you to that ticket. You can navigate through the results by clicking the Next Ticket or Previous Ticket links just below the main menu bar, or click the Back to Query link to return to the query page.

You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Query links after saving your results. When you return to the query any tickets which was edited will be displayed with italicized text. If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below.

You may want to save some queries so that you can come back to them later. You can do this by making a link to the query from any Wiki page.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria (see Query Language).

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Using the [[TicketQuery]] Macro

The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

#47
Dynamically add elements in the settings pane
#49
Copy & Paste function in Editor
#63
Groups names have to be multilingual
#74
LibGmpWrapper.dll/Primes failing to load on x64 OS
#75
Tooltip of output claims to be an input
#81
Plugin should be noticed about connected inputs
#87
CT2 may open a new .cte in a new tab
#207
Buttons "Close all tabs"
#276
Crash report 2011-05-25
#279
Crash report 2011-06-03
#282
Crash report 2011-06-14
#293
Crash report 2011-07-03
#308
Crash report 2011-07-05
#312
Crash report 2011-07-09
#316
Crash report 2011-07-14
#321
Crash report 2011-07-14
#322
Crash report 2011-07-14
#338
Crash report 2011-07-24
#344
Crash report 2011-08-03
#346
Crash report 2011-08-07
#347
Crash report 2011-08-08
#350
Crash report 2011-08-21
#363
Crash report 2011-09-08
#364
Crash report 2011-09-08
#372
Crash report 2011-09-15
#394
Crash report 2011-09-28
#427
Crash report 2011-10-31
#434
Crash report 2011-11-04
#457
Crash report 2011-11-20
#505
Copy&Paste for Workspace
#506
Removing elements from the workspace
#515
Crash report 2012-01-11
#566
Create framework for CrypExperience components
#573
Crash report 2012-03-08
#574
Crash report 2012-03-08
#580
Crash report 2012-03-12
#581
BinTextVisual exception (Crash report 2012-03-12)
#592
Crash report 2012-03-21
#593
Crash report 2012-03-21
#600
Crash report 2012-03-27
#601
Crash report 2012-03-27
#602
Crash report 2012-03-27
#603
Crash report 2012-03-27
#605
Crash report 2012-03-27
#606
Crash report 2012-03-27
#607
Crash report 2012-03-28
#608
Crash report 2012-03-31
#609
Crash report 2012-03-31
#610
Crash report 2012-03-31
#615
Crash report 2012-04-04
#632
Crash report 2012-04-20
#639
Crash report 2012-04-28
#700
OpenProject Bug #1
#860
Crash report 2014-07-09
#938
Crash report 2018-03-02
#1033
Crash report 2019-12-26
#1040
Crash report 2020-04-03

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language.

A more compact representation without the ticket summaries is also available:

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#47, #49, #63, #74, #75, #81, #87, #207, #276, #279, #282, #293, #308, #312, #316, #321, #322, #338, #344, #346, #347, #350, #363, #364, #372, #394, #427, #434, #457, #505, #506, #515, #566, #573, #574, #580, #581, #592, #593, #600, #601, #602, #603, #605, #606, #607, #608, #609, #610, #615, #632, #639, #700, #860, #938, #1033, #1040

Finally if you wish to receive only the number of defects that match the query using the count parameter.

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

57

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (&). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (|), meaning that the filter matches any of the values.

The available operators are:

= the field content exactly matches the one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

See also: TracTickets, TracReports, TracGuide