Note: this page was used to prepare the 0.12 version of wiki:/TracQuery, see now directly that toplevel page

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

Navigating Tickets

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.

Using TracLinks

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:

#181

Wiki preview injects new lines

#204

request for colour legend (or something similar) for ticket groups in reports

#226

Ticket Dependencies

#239

Link to diff of specifik wiki change instead of the page itself

#351

All ticket modifications should be tracked in timeline

#413

Installing on Windows, drive other than C:

#450

Diffviewer should try to convert the text into utf-8.

#475

merging of similar tickets

#519

Python process sometimes hangs on Windows Server 2003

#529

IE 5-6 over HTTPS broken downloads

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:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

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:

10

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

1 2 3 4 5 6 7 8 9 10 11 →

Ticket	Resolution	Summary	Owner	Reporter
#10555	fixed	make_ticket_comment should use [changeset:%s]	j@…	j@…
#10551	worksforme	Static files cannot be loaded		framay <franz.mayer@…>
#10550	worksforme	Trac crashes after OSX Lion Upgrade		bill.hernandez@…

1 2 3 4 5 6 7 8 9 10 11 →

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

1 2 3 4 5 6 7 8 9 10 11 →

Ticket	Resolution	Summary	Owner	Reporter
#10555	fixed	make_ticket_comment should use [changeset:%s]	j@…	j@…
Reported by j@…, 6 days ago.
Description	currently make_ticket_comment just wraps the changeset revisin in [revid] while closing tickets. depending on the version control backend changesets might not be detected correctly by the wiki. using an explicit [changeset:revid] will always work.
#10551	worksforme	Static files cannot be loaded		framay <franz.mayer@…>
Reported by framay <franz.mayer@…>, 8 days ago.
Description	I am facing the problem that no static page content of Trac is loaded anymore (means no CSS, Javascript and Image files). When looking into the logs, I am getting: 2012-02-02 08:45:21,234 Trac[build\bdist.win32\egg\trac\web\main] ERROR: Internal Server Error: Traceback (most recent call last): File "build\bdist.win32\egg\trac\web\main.py", line 478, in _dispatch_request dispatcher.dispatch(req) File "build\bdist.win32\egg\trac\web\main.py", line 198, in dispatch resp = chosen_handler.process_request(req) File "build\bdist.win32\egg\trac\web\chrome.py", line 569, in process_request and req.args['hash'] == self.static_hash KeyError: 'hash' I thought there have already been a ticket, but I haven't found it. I am using Trac 0.13dev-r10932 on that system.
#10550	worksforme	Trac crashes after OSX Lion Upgrade		bill.hernandez@…
Reported by bill.hernandez@…, 9 days ago.
Description	After upgrading to OSX Lion, and running the trac command, I got an error I had never encountered before. I then ran $sudo easy_install --upgrade Trac but that came up with yet another error. $ /usr/local/bin/tracd --port=8000 -e /dev_repo/dev_trac --basic-auth=*, /dev_repo/dev_trac/.htpasswd, /dev_repo/dev_trac/trac_/site ---------------------- The above command breaks down as follows: ---------------------- $ /usr/local/bin/tracd --port=8000 -e /dev_repo/dev_trac --basic-auth=* ,/dev_repo/dev_trac/.htpasswd ,/dev_repo/dev_trac/trac_/site ---------------------- ERROR ( 1 ) ---------------------- Traceback (most recent call last): File "/usr/local/bin/tracd", line 5, in <module> from pkg_resources import load_entry_point File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 2603, in <module> working_set.require(__requires__) File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 666, in require needed = self.resolve(parse_requirements(requirements)) File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 565, in resolve raise DistributionNotFound(req) # XXX put more info here pkg_resources.DistributionNotFound: Trac==0.12.2 $ So I tried to update tracd to see if that worked... $ sudo easy_install --upgrade Trac Searching for Trac Reading http://pypi.python.org/simple/Trac/ Reading http://trac.edgewall.org/ Reading http://trac.edgewall.org/wiki/TracDownload Reading http://trac.edgewall.com/ Reading http://projects.edgewall.com/trac Reading http://projects.edgewall.com/trac/wiki/TracDownload Best match: Trac 0.12.3rc1 Downloading ftp://ftp.edgewall.com/pub/trac/Trac-0.12.3rc1.zip ---------------------- ERROR ( 2 ) ---------------------- error: Download error for ftp://ftp.edgewall.com/pub/trac/Trac-0.12.3rc1.zip: ftp error: [Errno 54] Connection reset by peer $

1 2 3 4 5 6 7 8 9 10 11 →

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. 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 a semicolon (;). 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