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:

Ticket	Resolution	Summary	Owner	Reporter
#4	fixed	Maven 常用命令	刘庆元	liuqingyuan
#3	fixed	开发部门公用sonar和Hudson/Jenkins平台搭建		chenchongqi
#1	fixed	技术评审会	somebody	chenchongqi

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:

Ticket	Resolution	Summary	Owner	Reporter
#4	fixed	Maven 常用命令	刘庆元	liuqingyuan
Reported by liuqingyuan, 13 years ago.
Description	创建Maven的普通java项目： mvn archetype:create -DgroupId?=packageName -DartifactId?=projectName 创建Maven的Web项目： mvn archetype:create -DgroupId?=packageName -DartifactId?=webappName -DarchetypeArtifactId?=maven-archetype-webapp 编译源代码： mvn compile 编译测试代码：mvn test-compile 运行测试：mvn test 产生site：mvn site 打包：mvn package 在本地Repository中安装jar：mvn install 清除产生的项目：mvn clean 生成eclipse项目：mvn eclipse:eclipse 生成idea项目：mvn idea:idea 组合使用goal命令，如只打包不测试：mvn -Dtest package 编译测试的内容：mvn test-compile 只打jar包: mvn jar:jar 只测试而不编译，也不测试编译：mvn test -skipping compile -skipping test-compile ( -skipping 的灵活运用，当然也可以用于其他组合命令) 清除eclipse的一些系统设置:mvn eclipse:clean 显示版本信息: mvn -version/-v 运行项目于jetty上: mvn jetty:run 发布第三方Jar到本地库中： mvn deploy:deploy-file -DgroupId?=com -DartifactId?=client -Dversion=0.1.0 -Dpackaging=jar -Dfile=d:\client-0.1.0.jar -DrepositoryId?=maven-repository-inner -Durl= ftp://xxxxxxx/opt/maven/repository/ -DdownloadSources?=true -DdownloadJavadocs?=true 显示详细错误信息： mvn xxx -e 验证工程是否正确，所有需要的资源是否可用：mvn validate 运行任何检查，验证包是否有效且达到质量标准：mvn verify 产生应用需要的任何额外的源代码，如xdoclet ：mvn generate-sources help插件系列 mvn help:describe -Dplugin=help 使用 help 插件的 describe 目标来输出 Maven Help 插件的信息。 mvn help:describe -Dplugin=help -Dfull 使用Help 插件输出完整的带有参数的目标列 mvn help:describe -Dplugin=compiler -Dmojo=compile -Dfull 获取单个目标的信息,设置 mojo 参数和 plugin 参数。此命令列出了Compiler 插件的compile 目标的所有信息 mvn help:describe -Dplugin=exec -Dfull 列出所有 Maven Exec 插件可用的目标 mvn help:effective-pom 看这个“有效的 (effective)”POM，它暴露了 Maven的默认设置 在不往 classpath 载入适当的依赖的情况下，运行这个程序: mvn exec:java -Dexec.mainClass=org.sonatype.mavenbook.weather.Main Exec dependency插件系列 mvn dependency:resolve 打印出已解决依赖的列表 mvn dependency:tree 打印整个依赖树 打开 Maven 的调试标记查看完整的依赖踪迹，定位依赖冲突：mvn install -X 跳过测试 mvn install -Dmaven.test.skip=true 创建你应用程序特有分发包：mvn install assembly:assembly 使用 Hibernate3 插件构造数据库：mvn hibernate3:hbm2ddl[[BR]]
#3	fixed	开发部门公用sonar和Hudson/Jenkins平台搭建		chenchongqi
Reported by chenchongqi, 14 years ago.
Description	目前已经搭建完毕，电脑组已经迁移6个项目到公共平台上，还有论坛、游戏相关项目。 Jenkins:  http://ci.pc.com.cn/jenkins/ Sonar:  http://sonar.pc.com.cn/ Nexus:  http://ci.pc.com.cn/nexus/
#1	fixed	技术评审会	somebody	chenchongqi
Reported by chenchongqi, 14 years ago.
Description	介绍了sonar & hudson的基本功能 目前在电脑组的使用情况 相关优缺点

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