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

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:

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, use 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 7)

Ticket	Resolution	Summary	Owner	Reporter
#7	fixed	索引页左树优化	liangqinsheng	liangqinsheng
#6	fixed	汽车网论坛地图终端页的修改	罗伟铭	luoweiming
#5	fixed	车型参数对比	罗伟铭	luoweiming

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

Ticket	Resolution	Summary	Owner	Reporter
#7	fixed	索引页左树优化	liangqinsheng	liangqinsheng
Reported by liangqinsheng, 14 years ago.
Description	在5.5二期优化的时候，左树的优化花了好大的功夫。有如下几点 1.左树静态化，左树的更新通过定时任务更新，以减少页面的大小。 2.js后移，把工具条，车型切换的下拉列表等耗时内容后移，加快页面加载速度。 3.sql优化，把原来复杂的sql查询简单化，合并多余的sql，去除不需要的字段，减少返回的数据量，按需显示。 优化前后的性能对比可以参考 附件的测试报告。 除了性能之外的优化，还做了左树用户体验的优化，如用户点击某一个品牌，js会控制点击节点置顶，展开下面的子节点方便查询。然后每次翻页或重新选择条件，js都会重新定位好左树，不会丢失定位。 调试过程中遇到一个痛苦的问题，找了好久才知道。就是xyz下的品牌老是定位不到，通过js 打印出 各个参数检测又没有问题。开始怀疑是js的执行顺序有关。按图索骥，终于找到原因所在，因为左树的内容是动态通过js文件加载进来的，所以要等左树的所有dom建立好之后，才执行定位函数。如下 $(document).ready(function () { locateTree("pictree_".concat("${bid}")); });
#6	fixed	汽车网论坛地图终端页的修改	罗伟铭	luoweiming
Reported by luoweiming, 14 years ago.
Description	提供一个全新的数据接口给汽车论坛 包含汽车大全的，按品牌查找，按价格查找，按拼音查找，按级别查找 这几个数据接口
#5	fixed	车型参数对比	罗伟铭	luoweiming
Reported by luoweiming, 14 years ago.
Description	提高车型参数对比页的用户体验和速度。 对每一款选择的车型增加推荐栏目，方便用户对同级别相似度最高的车的对比。 具体需求附文档。

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