wiki:TracQuery

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, which can be used to display tickets that meet specified 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 in and no name/email is 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 dropdown 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 dropdown menu of options can be added multiple times to perform an Or on 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.

After you have 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

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 in by placing pipes (|) between the columns:

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

This is displayed as:

Results (1 - 3 of 63)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#63 fixed Replace %xgh with U+00gh in text randy_presuhn@…
#62 fixed (AD #14) DoS potential randy_presuhn@…
#61 fixed Problem with MAY in 3.5 on Description errata (Apps #13) randy_presuhn@…
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>:

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#63 fixed Replace %xgh with U+00gh in text randy_presuhn@…
Description

Issue raised in http://www.ietf.org/mail-archive/web/ltru/current/msg12889.html

Proposal is to replace the %xgh notation wherever it appears (other than in the ABNF itself) with the U+00gh notation, and to update references as needed.

#62 fixed (AD #14) DoS potential randy_presuhn@…
Description

Issue raised in http://www.ietf.org/mail-archive/web/ltru/current/msg12801.html

14). Language Tag validity verification requires applications to keep up-to-date copies of the Language Tag registry. Such applications might be designed to automatically fetch new versions of the registry. This has three problems: I). IANA is generally not happy about applications automatically downloading registries, unless data is located in DNS. This is primarily to scaling concerns. II). There is also the issue of when application should be fetching the updated registry. I.e. what is the mechanism(s) for determining when to fetch. III). The registry format is not designed for figuring out the minimal list of changes between any 2 versions. For example there is no way of only fetching changes since a given File-Date value.

BTW, are people aware of implementations that try to download Language Tag registry automatically?

While I don't expect this issue to be fully fixed at such a late stage, it needs to be discussed in the document. Some thoughts about what can be said on the topic:

Regarding I): application should be advised against frequent polling of the registry. For example:

The registries specified in this document are not suitable for applications that require real-time access to, or retrieval, of the full registry contents.

It might be nice to have the File-Date value available as a separate short piece of data (a separate web page on IANA's website, a thing in DNS, etc. But even with existing registry format it might be possible to minimize load on IANA's website by describing how HTTP/1.1 features can be used to only download necessary information, such as downloading the beginning of the registry which contains the File-Date field.

Regarding II): I think this needs some advice on which operations need and which don't need fetching of the registry.

Also this might mention that any application keeping a copy of the registry needs to preserve the File-Date value in some form.

Regarding III): I think it is Ok for now to explicitly acknowledge that this is an issue.

It might also be worth discussing how the registry format facilitates "diffing" 2 versions of the registry.

#61 fixed Problem with MAY in 3.5 on Description errata (Apps #13) randy_presuhn@…
Description

Issue raised in http://www.ietf.org/mail-archive/web/ltru/current/msg12772.html

13). In Section 3.5:

While the 'Description' field itself is not guaranteed to be stable and errata corrections MAY be undertaken from time to time, attempts to provide translations or transcriptions of entries in the registry itself will probably be frowned upon by the community or rejected outright, as changes of this nature have an impact on the provisions in Section 3.4.

Suggested replacement for the paragraph:

The 'Description' field itself is not guaranteed to be stable. Corrections (possibly as errata) and updates are permitted with adequate justification. However, addition of translations or transliterations are not considered sufficient justification for corrections or updates.

Reason: use of MAY is not an appropriate use of RFC 2119, as it is trying to forecast the future and doesn't specify a protocol option.

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. Filters are separated by ampersands (&). Each filter 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 omitted 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, TicketQuery

Last modified 3 years ago Last modified on 05/11/16 18:55:06