wiki:TracQuery

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

--

Trac Ticket Queries

Table of Contents

In addition to reports, Trac provides support for custom ticket queries, which can be used to display tickets that meet specified 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 filter will display tickets relevant to you:

  • If logged in then all open tickets, it will display open tickets assigned to you.
  • If not logged in but you have specified a name or email address in the preferences, then it will display all open tickets where your email (or name if email not defined) is in the CC list.
  • If not logged in and no name/email is defined in the preferences, then all open issues are displayed.

Current filters can be removed by clicking the button to the left with the minus sign on the label. New filters are added from the pulldown lists at the bottom corners of the filters box; 'And' conditions on the left, 'Or' conditions on the right. Filters with either a text box or a pulldown menu of options can be added multiple times to perform an Or on 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.

After you have 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

Trac allows you to save the query as a named query accessible from the reports module. To save a query ensure that you have Updated the view and then click the Save query button displayed beneath the results. You can also save references to queries in Wiki content, as described below.

Note: one way to easily build queries like the ones below, you can build and test the queries in the Custom report module and when ready - click Save query. This will build the query string for you. All you need to do is remove the extra line breaks.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

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

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 in by placing pipes (|) between the columns: 

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

This is displayed as:

Ticket Resolution Summary Owner Reporter
#5 fixed Italian boot menu renders incorrectly lewisr
#4 fixed menu.brn driver string is malformed in certain cases lewisr
#3 invalid genproto has difficulty parsing some NIFs lewisr

Full rows

In table format you can also have full rows by using rows=<field>: 

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

This is displayed as:

Ticket Resolution Summary Owner Reporter
#5 fixed Italian boot menu renders incorrectly lewisr
Description

Although there were no textual changes between 2019.08.08 and 2021.08.12, the rendering of the opening boot menus is broken in the later build. See screenshots, attached.

#4 fixed menu.brn driver string is malformed in certain cases lewisr
Description

There seems to be some discrepancy between the length defined for a given driver description and driver name and how the string is interpreted when placed into the defined variable.

Example:

Given the following CONFIG.SYS statement to be completed: 

DEVICE=\^DEV_CDROM:********^.DMD^MISC_PROB_VERBOSE:false: /Q^^MISC_PROB_VERBOSE:true: /V^

The following strings all work: 

; *note: Driver name *must* always be in brackets at the end of the string
;
; max. length:               >1234567890123456789012345678901234567890123<
'<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD-Gerätemanager    (OS2CDROM)'
'<DEV_CDROM_LIST_01>'      = 'Standard CD/DVD-Gerätemanager    (OS2CDROM)'
'<DEV_CDROM_LIST_02>'      = 'Erweiterter CD/DVD-Gerätemanager (JJSCDROM)'
'<DEV_CDROM_LIST_03>'      = 'Legacy CD-Gerätemanager          (OLDCDROM)'

whereas results from these strings are inconsistent: 

; *note: Driver name *must* always be in brackets at the end of the string
;
; max. length:               >1234567890123456789012345678901234567890123<
'<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD Geräte-Manager  (OS2CDROM)'
'<DEV_CDROM_LIST_01>'      = 'Standard CD/DVD Geräte-Manager  (OS2CDROM)'
'<DEV_CDROM_LIST_02>'      = 'Erweiterter CD/DVD Ger.-Manager (JJSCDROM)'
'<DEV_CDROM_LIST_03>'      = 'Alter CD-Geräte-Manager         (OLDCDROM)'

In the latter case, 'Standard CD/DVD Geräte-Manager (OS2CDROM)' results in <DEV_CDROM_LIST_01> being placed into CONFIG.SYS as:

\S2CDROM).DMD

The same corruption is seen for <DEV_CDROM_LIST_02>, which ends up as:

\JSCDROM).DMD

Yet, <DEV_CDROM_LIST_03>, (with greater padding?) is properly entered.

However, by adding (back) the extra spaces: 

; *note: Driver name *must* always be in brackets at the end of the string
;
; max. length:               >1234567890123456789012345678901234567890123<
'<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD Geräte-Manager   (OS2CDROM)'
'<DEV_CDROM_LIST_01>'      = 'Standard CD/DVD Geräte-Manager   (OS2CDROM)'
'<DEV_CDROM_LIST_02>'      = 'Erweiterter CD/DVD Ger.-Manager  (JJSCDROM)'
'<DEV_CDROM_LIST_03>'      = 'Alter CD-Geräte-Manager          (OLDCDROM)'

all variables are properly filled.

I haven't seen this anywhere else, yet, nor have I tested without the umlauts.

#3 invalid genproto has difficulty parsing some NIFs lewisr
Description

While installing ArcaOS on Hawking, I was forced to use the Compaq-supplied B57 NIC driver (neither the MMBGE nor the Broadcom reference driver work correctly on that hardware). During boot, GENPROTO complained about the duplex setting in the NIF:

Nif-parser: B57.nif#58: String "HALF" is longer that allowed StrLength.

This comes from GENPROTO.PAS.

For its part of the incident, the NIF actually says: 

[Duplex]
tag = DUPLEX
display = "Duplex Mode"
type = string
strlength = 3
set = HALF,FULL
optional = YES
editable = YES
help = "This parameter specifies duplex mode on the ethernet controller.  This parameter is optional unless the Linespeed parameter is specified.  The Linespeed parameter must be set when this keyword is used.  If neither the Duplex nor the Linespeed paramaters are specified the ethernet controller will default to autonegotiate mode."

(including the misspelling of "parameters" in the last sentence)

Query Language

query: TracLinks and the [[TicketQuery]] macro both use a mini “query language” for specifying query filters. Filters are separated by ampersands (&). Each filter 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. To include a literal & or | in a value, escape the character with a backslash (\).

The available operators are:

= the field content exactly matches 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

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by two dots (..). Either end of the date range can be left empty, meaning that the corresponding end of the range is open. The date parser understands a few natural date specifications like "3 weeks ago", "last month" and "now", as well as Bugzilla-style date specifications like "1d", "2w", "3m" or "4y" for 1 day, 2 weeks, 3 months and 4 years, respectively. Spaces in date specifications can be omitted to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide, TicketQuery