Version 1 (modified by trac, 15 years ago) (diff)

—

Trac Ticket Queries

Table of Contents

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 were 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:

#69
Add orientation to 1D plots
#202
Fix auto build of sphinx documentation
#207
Batch fitting does not display the correct data
#258
Windows installer problems when previous versions are not uninstalled
#343
SESANS data loader
#369
clean up ImageViewer interface
#380
Build number is still 1 in installer version
#388
Need BUMPS usage documentation
#403
Two "Fitting" menus
#415
Save Project and Save Analysis don't open on double clicking
#537
Magnetic sld not implemented for python models
#630
rev-parse problem when running from non-git/unitilized directory
#655
Polydispersity array doesn't work
#739
Load project issues
#748
plug-in model unit tests from python shell not always working?
#752
"compute" button still not working
#755
S(q) models should not have scale and background parameters added
#781
blank fit page when selecting old style plugin after reload
#831
only process ticket updates from checkin messages when merged to master
#863
Load Plugin error
#899
Igor Reader q calculation
#904
Separated P(Q) and S(Q) not updated when model changes
#944
non fitting or derived parameters in models
#954
cross check dll/opencl/python polydispersity and orientation results
#964
use Si from cephes
#1101
Batch results page not displaying polydispersity values
#1119
external calls to sasmodels needing beta(Q)
#1127
File Loader is not loading valid NXcanSAS
#1168
Create a separate Teixeira Fractal Structure Factor
#1181
Add FitPage name to Graph Title
#1189
some magnetic parameters need to be hidden for multiplicity models
#1260
Provide enhanced plugin testing in GUI
#1261
Default parameters for RPA model are generating an invalid example plot

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:

#69, #202, #207, #258, #343, #369, #380, #388, #403, #415, #537, #630, #655, #739, #748, #752, #755, #781, #831, #863, #899, #904, #944, #954, #964, #1101, #1119, #1127, #1168, #1181, #1189, #1260, #1261

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:

33

Customizing the table format

You can also customize the columns displayed in the table format (format=table) by using col≤field> - you can specify multiple fields and what order they are displayed by placing pipes (|) between the columns like below: 

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

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