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.


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

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

Using the [[TicketQuery]] Macro

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



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. This also allows displaying the link and description of a single ticket:


This is displayed as:

No results

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, use the count parameter.

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

This is displayed as:


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:


This is displayed as:

Results (1 - 3 of 67)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#77 fixed Bad performance of query_formatted() cito justin
#76 fixed Support and document usage of prepared statements cito
#75 fixed Add autocommit option to DB API 2 cito
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:


This is displayed as:

Results (1 - 3 of 67)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#77 fixed Bad performance of query_formatted() cito justin

This was posted by Justin to the mailing list 2019-04-01:

I was going to do a performance test for prepared queries, specifically for INSERTs: simple queries, query_formatted, inline=True+False, SQL EXECUTE, pgdb, dicts and PQexecPrepared.

I didn't get far before needing to step back, as I'm shocked by how slow parameter formatting is, just to turn %s into $1. It's nearly 10x slower than query() with $1 params. That's true for pg (which can send params out of line) and pgdb (which always inlines params).

If I'd noticed 2 years ago, I might have avoided using DB.query_formatted() just to let developers use %s formats. Perhaps the only reason why this isn't causing issues for our data loaders is that each CPU heavy formatted INSERT is partially balanced with I/O on the DB server. But I can easily imagine that being a deal-breaker. Maybe I'm wrong, but I'd have expected the additional processing cost to be within 10% or 20% of query, and certainly within a factor of two.

BTW, prepared query completely avoids this by avoiding all the isinstance which appears to be most of the expense. The high performance cost and mitigation (prepares) should be documented. Also, I realized that SQL EXECUTE is a bad way to do it, and maybe shouldn't be documented, since it requires quoting each parameter (which is slow and thereby defeats itself).

I tried to use cProfile to find hotspots and guessed at the rest until it worked. My tweaks make it 3x faster - however, it's still 3x slower than query()!

My changes are not very "disciplined" so please consider this a proof of concept written by a non pytho-phone. I didn't touch pgdb and I haven't tested with dict formats. I imagine you may have a better idea how/what to cache.

3 runs on a semi-idle server with checkpoint_interval=60sec. 100000rows and 100cols (I believe this scales roughly as rows*cols)

methodunpatchedpatched time (sec)
pg simple insert with txn:(105 98 91)
pg query() $1 params:(169 172 178)174
pg query_formatted %s params:(745)314
pg insert using inline=True:(386)187
pg prepare_query + execute_prepared(n/a)(90, 88, 94)
note, that's not included in this patch
pgdb insert with/out paramsTODO
SQL EXECUTE + $1 + inline=True:TODO

Find attached my patch and test, which was meant to approximate our loader processes, which I'd like to convert to use prepared query.

#76 fixed Support and document usage of prepared statements cito

The C module needs to be extended to support the PQprepare, PQexecPrepared and PQdescribePrepared functions.

The pg and pgdb interfaces need to make use of this.

See also mailing list 2018-12-09 and #16.

#75 fixed Add autocommit option to DB API 2 cito

The DB API 2 connection should get an attribute or methods allowing to put the connection into auto-commit mode since there are a few commands like "create database" or "vacuum" that can only be issued in that mode. As a workaround, you can currently use the classic module to issue such commands.

See and for how this is done in Psycopg2.

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

Last modified 7 years ago Last modified on Feb 25, 2013, 9:13:16 AM