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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#34 fixed should we include a raw tzdb format media type? cyrus@… lear@…
#33 fixed “substantive” change draft-ietf-tzdist-service@… cyrus@…
#32 fixed managing historical data cyrus@… lester@…
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 31)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#34 fixed should we include a raw tzdb format media type? cyrus@… lear@…
Description

I am not fully convinced that this needs to be done in this draft, but I do think it would be a good idea to support the raw format, so that simple systems don't need to do the recompile. An iPhone will not be the smallest system to run this code, we hope.

In favor of putting the media type in the draft is that we can test whether multiple formats can in fact be supported. The bad is that it could slow us down just a little, and I would rather not include anything for which there isn't a willingness by someone to write out some code on both ends to test.

It is possible to include this as a separate draft, but we need to be very comfortable that we haven't made a mistake draft-ietf-tzdist-service that would cause a problem. So for instance, those files normally come over at the level of a continent. What would a query look like?

Let's discuss.

#33 fixed “substantive” change draft-ietf-tzdist-service@… cyrus@…
Description

Current draft has:

When listing time zones, a timestamp is returned by the server, and that can be used later by clients to determine if any "substantive" change has occurred in the time zone data. Clients can use a conditional "list" action (see Section 6.2), supplying a previous timestamp value, to limit the results to time zones which have changed in a "substantive" manner since that previous timestamp. This allows clients to cache the last timestamp and to periodically poll the server for possible changes.

A "substantive" change is one which affects the calculated onsets for a time zone. Changes to properties such as a description are not treated as a "substantive" change.

There has been debate on the list as to what exactly a “substantive” change is. We need to clarify this. Or alternatively do away with “substantive” and instead require any change, no matter how minor, to result in the corresponding tzid being reported as changed.

#32 fixed managing historical data cyrus@… lester@…
Description

If I provide archived data that has been created using the current set of timezone data and in ten years time someone is accessing that data they need to be able to process the data using the SAME view of the timezone data. This may well have changed so that the current data set is different, and while 'changed_since' can say that there has been a change, it provides no basis on which to access just what has changed in the intervening 10 years. The user needs to be able to ask for the correct view from ten years ago as they did not have that data as a starting point with which to use the current data.

If we haven't built the handling of this into the standard now, then in ten years time the historic data is unusable. Or we need a different source of tz data that can be relied on in the future for that application.

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 6 years ago Last modified on 05/11/16 19:07:34