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

Some shortcuts can be used to manipulate checkbox filters.

  • Clicking on a filter row label toggles all checkboxes.
  • Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
  • Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter.

The modifier key is platform and browser dependent. On Mac the modified key is Option/Alt or Command. On Linux the modifier key is Ctrl + Alt. Opera on Windows seems to use Ctrl + Alt, while Alt is effective for other Windows browsers.

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#447 fixed r6601 PSI font requester font styles strange/missing styles Thore Böckelmann Javier de las Rivas
#445 fixed MUI prefs: Failed to create application (20) - on another MUI preferences run Thore Böckelmann Hubert Maier
#444 fixed SnapIT: Causes a system freeze Hubert Maier
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 433)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#447 fixed r6601 PSI font requester font styles strange/missing styles Thore Böckelmann Javier de las Rivas
Description

Summary

Just found it with r6601, opening PSI window and MUI font requester missing some styles (shadow, outline and normal)

Steps to reproduce

1.Open MUI main and go to Screen/PSI option 2.Click on font gadget to get mui font requester

Expected results

Actual results

Regression

Notes

#445 fixed MUI prefs: Failed to create application (20) - on another MUI preferences run Thore Böckelmann Hubert Maier
Description

Summary

If MUI prefs is already running and started a second time, an error message in a console window pops up: Failed to create application (20).

Steps to reproduce

  1. run MUI prefs
  2. run MUI prefs again

Expected results

  1. No error message, i guess
  2. Adding "uniconify" followed by a "bring to front" would be best probably.

Actual results

See summary

  1. If the prefs window is hidden behind other windows it is brought to front.
  2. If the prefs window is iconified, nothing happens.

Regression

Nope, at least i don't think so, never tried it before.

Notes

#444 fixed SnapIT: Causes a system freeze Hubert Maier
Description

Summary

A screengrabber, based on MUI and called SnapIT (https://www.onyxsoft.se/snapit.html), is causing a complete system freeze when bringing up the context menu (right mouse click) while bubble help is active over an interactive window list.

Steps to reproduce

  1. Start it without changing anything
  2. Move the mouse cursor to the "Window List" field
  3. Wait until the help bubble comes up

There is yet another window created in the list called "SnapIT" (for the help bubble)

  1. Without moving the mouse, right click to bring up SnapIT's workbench menu

Expected results

No freeze. There should just the context menu coming up, nothing else.

Actual results

A complete system freeze with no crash, no crash log and absolutely nothing on serial. It looks like as if the system is instantly screeching to a full stop.

Regression

Don't think so, i never tested or used the program before, so i can't really tell.

Notes

Nothing useful probably, but here goes:

  1. I tried every single MUI demo, but couldn't find a similar list that will bring up bubble help, so i can't really test if this is intended behaviour, i guess not though, since i can make the right-click menu come up perfectly fine, if i right-click into the list fast enough *before* bubble help comes up and creates the new entry.
  2. I *think*, but that is a shot in the dark, that there is a race condition where MUI tries to remove bubble help (and the extra entry) while the brought up Workbench menu has already locked the SnapIT window (at least it locks the MUI preferences window in it's "Busy" setting, by stopping the amimation, if i right-click on the window border between "Save" and "Use" - so i'm assuming it does the same here?).

Program specific:

  1. There also seems to be another bug in either MUI or the SnapIT app. While bubble help comes up, focus on the formerly marked entry in the list is lost and moved wrongly down up one entry, since the whole list is moved down when bubble help's entry is added.

Let me know if you need another bug item for this.

  1. The whole window list seems to be an "object", not sure if this adds to the problem? If i move the cursor around inside the list, bubble help stays where it was first opened. If i click on another entry, no new bubble help will come up, instead it will be removed, together with the extra entry. If i now do a right-click, everythings works fine. I have to move outside the window list and come back to make bubble help reappear.
  2. There is no "bubble help" entry in "Components", so i left it undefined.

If you need more information or testing, just shout.

Thank you for the ongoing development

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 4 years ago Last modified on Dec 27, 2016, 1:09:11 AM