wiki:TracQuery
Last modified 14 months ago

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 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 and no name/email defined in the preferences then all open issues are displayed.

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

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.

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:

No results

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:

No results

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:

0

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:

Results (1 - 3 of 155)

Ticket Resolution Summary Owner Reporter
#259 fixed log an error message in the igdaemon on device error jdunn jdunn
#253 invalid igclient: /lib/libpopt.so.0: no version information available (required by igclient) bluey tmetro
#250 fixed Transceiver disconnects repeatedly somebody av

Full rows

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

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

This is displayed as:

Results (1 - 3 of 155)

Ticket Resolution Summary Owner Reporter
#259 fixed log an error message in the igdaemon on device error jdunn jdunn

Reported by jdunn, 4 weeks ago.
Description

Currently when the device sends back an error message we log it only as the hex value and pass it on to the client application. Since the client application is commonly lircd where we have little control over the logging we should log a warning in the igdaemon on error. For example, when the device sends 0x32 we should log something like "oversend error on device 1"

#253 invalid igclient: /lib/libpopt.so.0: no version information available (required by igclient) bluey tmetro

Reported by tmetro, 7 weeks ago.
Description

I found ticket 89:  http://iguanaworks.net/projects/IguanaIR/ticket/89

that documents this as a known issue for 64-bit systems, but I'm seeing it on a 32-bit system:

% uname -a Linux mythtv 2.6.24-30-386 #1 Mon Jan 2 19:05:25 UTC 2012 i686 GNU/Linux

Regardless, I'm assuming this is still a warning that can be ignored.

#250 fixed Transceiver disconnects repeatedly somebody av

Reported by av, 3 months ago.
Description

I've tried using the USB IR tranceiver on both Linux and OSX 10.6, and both exhibit the same behavior: the system reports that the US B device connects and immediately disconnects, repeatedly. The only command to which I've ever gotten the tranceiver to correctly respond is VERSION.

Am I doing something wrong, or could there be something wrong with the tranceiver? 

~$ ps -ef | grep  iguana
iguanair  1163     1  0 21:24 ?        00:00:00 /usr/bin/igdaemon --log-level=0 --send-timeout=1000 --receive-timeout=1000 --driver=libusb -l /var/log/iguanaIR.log
~$ igclient --get-version
get version: failed: 110: Connection timed out
~$ igclient --get-version
get version: failed: 110: Connection timed out
~$ igclient --get-version
Feb 19 22:06:08 2012 ERROR: Failed to connect to iguanaIR daemon: No such file or directory: is the daemon running and the device connected?
~$ igclient --get-version
get version: failed: 110: Connection timed out
~$ sudo /etc/init.d/iguanaIR stop
 * Stopping Iguanaworks USB IR daemon...                                                                                   [ OK ] 
~$ igdaemon -n -v -v -v
Feb 19 22:06:46 2012 DEBUG: Parameters:
Feb 19 22:06:46 2012 DEBUG:   recvTimeout: 1000
Feb 19 22:06:46 2012 DEBUG:   sendTimeout: 1000
Feb 19 22:06:46 2012 INFO: Loaded driver: /usr/lib/iguanaIR/libusbpre1.so
Feb 19 22:06:47 2012 ERROR:   trying to claim usb:6:0
Feb 19 22:06:47 2012 ERROR:   updateDeviceList failed: Failed to set device configuration: could not set config 1: Operation not permitted
Feb 19 22:06:47 2012 ERROR: scan failed.
^C~$ sudo igdaemon -n -v -v -v
Feb 19 22:06:56 2012 DEBUG: Parameters:
Feb 19 22:06:56 2012 DEBUG:   recvTimeout: 1000
Feb 19 22:06:56 2012 DEBUG:   sendTimeout: 1000
Feb 19 22:06:56 2012 INFO: Loaded driver: /usr/lib/iguanaIR/libusbpre1.so
Feb 19 22:06:57 2012 DEBUG: Handling 1 device(s):
Feb 19 22:06:57 2012 DEBUG:   0) usb:6.14 id=0 addr=0x1b53c90
Feb 19 22:06:57 2012 INFO: Worker 0 starting
Feb 19 22:06:57 2012 DEBUG2: o0x0000cd01
Feb 19 22:06:57 2012 DEBUG2: i0x0000dc010603
Feb 19 22:06:57 2012 DEBUG: Received ctl header: 0x1
Feb 19 22:06:57 2012 INFO: Transaction: 0x1 (10906 microseconds)
Feb 19 22:06:57 2012 INFO: Found device version 0x306
Feb 19 22:06:57 2012 DEBUG2: o0x0000cd1f
Feb 19 22:06:58 2012 INFO: Timeout while waiting for response from device.
Feb 19 22:06:58 2012 INFO: Failed to get id.  Device may not have one assigned.
Feb 19 22:06:59 2012 DEBUG2: i0x
Feb 19 22:06:59 2012 DEBUG: 0 length recv on 0.
Feb 19 22:06:59 2012 DEBUG2: i0x
Feb 19 22:06:59 2012 DEBUG: 0 length recv on 0.
Feb 19 22:06:59 2012 DEBUG2: i0x
Feb 19 22:06:59 2012 DEBUG: 0 length recv on 0.
Feb 19 22:06:59 2012 DEBUG2: i0x
Feb 19 22:06:59 2012 DEBUG: 0 length recv on 0.
Feb 19 22:06:59 2012 INFO: Device 0 unplugged
Feb 19 22:06:59 2012 INFO: Worker 0 exiting
Feb 19 22:07:00 2012 DEBUG: Handling 1 device(s):
Feb 19 22:07:00 2012 DEBUG:   0) usb:6.15 id=0 addr=0x1b4e120
Feb 19 22:07:00 2012 INFO: Worker 0 starting
Feb 19 22:07:00 2012 DEBUG2: o0x0000cd01
Feb 19 22:07:00 2012 DEBUG2: i0x0000dc010603
Feb 19 22:07:00 2012 DEBUG: Received ctl header: 0x1
Feb 19 22:07:00 2012 INFO: Transaction: 0x1 (10895 microseconds)
Feb 19 22:07:00 2012 INFO: Found device version 0x306
Feb 19 22:07:00 2012 DEBUG2: o0x0000cd1f
Feb 19 22:07:01 2012 INFO: Timeout while waiting for response from device.
Feb 19 22:07:01 2012 INFO: Failed to get id.  Device may not have one assigned.
Feb 19 22:07:02 2012 DEBUG2: i0x
Feb 19 22:07:02 2012 DEBUG: 0 length recv on 0.
Feb 19 22:07:02 2012 DEBUG2: i0x
Feb 19 22:07:02 2012 DEBUG: 0 length recv on 0.
Feb 19 22:07:02 2012 DEBUG2: i0x
Feb 19 22:07:02 2012 DEBUG: 0 length recv on 0.
Feb 19 22:07:02 2012 INFO: Device 0 unplugged
Feb 19 22:07:02 2012 INFO: Worker 0 exiting
Feb 19 22:07:03 2012 DEBUG: Handling 1 device(s):
Feb 19 22:07:03 2012 DEBUG:   0) usb:6.16 id=0 addr=0x1b60630
Feb 19 22:07:03 2012 INFO: Worker 0 starting
Feb 19 22:07:03 2012 DEBUG2: o0x0000cd01
Feb 19 22:07:03 2012 DEBUG2: i0x0000dc010603
Feb 19 22:07:03 2012 DEBUG: Received ctl header: 0x1
Feb 19 22:07:03 2012 INFO: Transaction: 0x1 (16922 microseconds)
Feb 19 22:07:03 2012 INFO: Found device version 0x306
Feb 19 22:07:03 2012 DEBUG2: o0x0000cd1f
Feb 19 22:07:04 2012 INFO: Timeout while waiting for response from device.
Feb 19 22:07:04 2012 INFO: Failed to get id.  Device may not have one assigned.
^CFeb 19 22:07:05 2012 INFO: Device 0 released
Feb 19 22:07:05 2012 INFO: Worker 0 exiting
Feb 19 22:07:05 2012 DEBUG: Reaped child: 0x7f684f22f700

Query Language

"[Error: Query filter requires field and constraints separated by a "="]

Error: Macro TicketQuery(None) failed
expected string or buffer
" 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. To include a litteral "&" or "|" in a value, escape the character with a backslash ("\").

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

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 left out 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