Note: this page documents the 0.12 version of Trac, see 0.11/TracQuery if you need the previous version
Trac Ticket Queries
Table of Contents
Languages:
- Deutsch
- English
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.
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.
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:
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:
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:
- #181
- Wiki preview injects new lines
- #204
- request for colour legend (or something similar) for ticket groups in reports
- #226
- Ticket Dependencies
- #239
- Link to diff of specifik wiki change instead of the page itself
- #351
- All ticket modifications should be tracked in timeline
- #413
- Installing on Windows, drive other than C:
- #450
- Diffviewer should try to convert the text into utf-8.
- #475
- merging of similar tickets
- #519
- Python process sometimes hangs on Windows Server 2003
- #529
- IE 5-6 over HTTPS broken downloads
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. This also allows displaying the link and description of a single ticket:
[[TicketQuery(id=123)]]
This is displayed as:
- #123
- No SQL error display
A more compact representation without the ticket summaries is also available:
[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
This is displayed as:
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:
10
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 8904)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #10702 | invalid | I can't send any form. | mparchet@… | |
| #10701 | cantfix | UnicodeEncodeError: 'ascii' codec can't encode characters in position 2-4: ordinal not in range(128) | admin | |
| #10700 | cantfix | UnicodeDecodeError after upgrade | anonymous |
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 8904)
| Ticket | Resolution | Summary | Owner | Reporter | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| #10702 | invalid | I can't send any form. | mparchet@… | ||||||||||||||||||||||||||||||||||||||||
| Description |
Hello, For some time I can't send any forms with firefox 12.0 for mac os x lion because the form's send button has no effect. Here is an example. https://support.microsoft.com/contactus/emailcontact.aspx?scid=sw;fr;1517&ws=SalesandLicensing Can you fix this bug quickly. Best regards Battant |
||||||||||||||||||||||||||||||||||||||||||
| #10701 | cantfix | UnicodeEncodeError: 'ascii' codec can't encode characters in position 2-4: ordinal not in range(128) | admin | ||||||||||||||||||||||||||||||||||||||||
| Description |
How to ReproduceWhile doing a GET operation on /report/10, Trac issued an internal error. (please provide additional details here) Request parameters: {'ACCEPTED': u'accepted',
'ASSIGNED': u'assigned',
'BILLABLE': u'1',
'CLOSED': u'closed',
'ENDDATE': u'2000000000000000',
'NEW': u'new',
'REOPENED': u'reopened',
'STARTDATE': u'0',
'UNBILLABLE': u'1',
'id': u'10'}
User agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.5 (KHTML, like Gecko) Chrome/19.0.1084.46 Safari/536.5 System Information
Enabled Plugins
Python TracebackTraceback (most recent call last):
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/web/main.py", line 522, in _dispatch_request
dispatcher.dispatch(req)
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/web/main.py", line 243, in dispatch
resp = chosen_handler.process_request(req)
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/ticket/report.py", line 118, in process_request
template, data, content_type = self._render_view(req, id)
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/ticket/report.py", line 532, in _render_view
if resource.realm.upper()+'_VIEW' not in req.perm(resource):
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/perm.py", line 553, in has_permission
return self._has_permission(action, resource)
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/perm.py", line 567, in _has_permission
check_permission(action, perm.username, resource, perm)
File "/usr/local/lib/python2.7/dist-packages/Trac-0.12.3-py2.7.egg/trac/perm.py", line 454, in check_permission
perm)
File "/usr/local/lib/python2.7/dist-packages/timingandestimationplugin-1.2.7b-py2.7.egg/timingandestimationplugin/ticket_policy.py", line 23, in check_permission
rtn = self.check_ticket_access(perm, resource, username)
File "/usr/local/lib/python2.7/dist-packages/timingandestimationplugin-1.2.7b-py2.7.egg/timingandestimationplugin/ticket_policy.py", line 61, in check_ticket_access
self.log.warning("Internal: TandE ticket_policy failed to find a ticket for %s : error: %s" % (res, e))
UnicodeEncodeError: 'ascii' codec can't encode characters in position 2-4: ordinal not in range(128)
|
||||||||||||||||||||||||||||||||||||||||||
| #10700 | cantfix | UnicodeDecodeError after upgrade | anonymous | ||||||||||||||||||||||||||||||||||||||||
| Description |
Hello, I just upgraded trac to trac-0.12.3-3.el6.noarch, the newest package from epel repository for centos. After upgrade I saw this error: Trac detected an internal error: UnicodeDecodeError: 'utf8' codec can't decode byte 0xc4 in position 69: invalid continuation byte Python Traceback Most recent call last: File "/usr/lib/python2.6/site-packages/trac/web/main.py", line 525, in _dispatch_request dispatcher.dispatch(req) File "/usr/lib/python2.6/site-packages/trac/web/main.py", line 246, in dispatch resp = chosen_handler.process_request(req) File "/usr/lib/python2.6/site-packages/trac/wiki/web_ui.py", line 117, in process_request page = WikiPage(self.env, pagename) File "/usr/lib/python2.6/site-packages/trac/wiki/model.py", line 44, in __init__ self._fetch(name, version, db) File "/usr/lib/python2.6/site-packages/trac/wiki/model.py", line 67, in _fetch row = cursor.fetchone() File "/usr/lib/python2.6/site-packages/trac/db/mysql_backend.py", line 43, in fetchone return row and self._convert_row(row) or None File "/usr/lib/python2.6/site-packages/trac/db/mysql_backend.py", line 40, in _convert_row for v in row]) File "/usr/lib64/python2.6/encodings/utf_8.py", line 16, in decode return codecs.utf_8_decode(input, errors, True) System Information: User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.5; rv:11.0) Gecko/20100101 Firefox/11.0
Enabled Plugins:
I'm using trac with http, mod_python and mysql backend. I think there is any strange character in the database. Therefore I created a mysqldump and then a hexdump. # grep --colour=auto -iE "\ c4\ [0-9a-f][0-9a-f]" trac.hex 00039070 3d 3d 3d 20 c4 8c 65 73 6b 79 20 3d 3d 3d 5c 6e |=== ..esky ===\n| 00039080 c4 8c 65 c5 a1 74 69 6e 61 20 76 20 6b c3 b3 64 |..e..tina v k..d| 00039160 48 72 76 61 74 73 6b 69 20 2d 20 c4 8d c4 87 c5 |Hrvatski - .....| 00039170 be c5 a1 c4 91 20 c4 8c c4 86 c5 bd c5 a0 c4 90 |..... ..........| 000394d0 64 61 20 61 72 c4 ab 20 73 74 72 c4 81 64 c4 81 |da ar.. str..d..| 00039520 c5 a1 6b 6f 73 20 72 61 69 64 c4 97 73 3f 20 c4 |..kos raid..s? .| 00039530 85 c4 8d c4 99 c4 97 c4 af c5 a1 c5 b3 c5 ab c5 |................| 00039540 be 20 c4 84 c4 8c c4 98 c4 96 c4 ae c5 a0 c5 b2 |. ..............| 000397b0 63 68 6e c4 85 c4 87 20 77 20 74 c4 99 20 c5 82 |chn.... w t.. ..| 00039800 69 65 6e 6e c4 85 20 70 72 7a 65 6b 75 6b 61 2e |ienn.. przekuka.| 000399d0 6b 6f 73 20 c4 8d 69 6e 6a 65 6e 69 63 69 20 64 |kos ..injenici d| 00039a40 6b 61 66 65 63 20 70 75 c5 a1 c4 8d 61 20 76 6f |kafec pu....a vo| 00039c30 e1 bb 87 74 20 63 c5 a9 6e 67 20 c4 91 c6 b0 e1 |...t c..ng .....| Some grepping leads to the point that I only have these characters within the language descriptions of trac. I compared this grep output to the original mysqldump. After that I started searching for an according debug mechanism to get detailed output in the trac log, but all I found was: default_charset = iso-8859-15 Could that be the problem? It would be really nice if you could give me an idea how to solve this issue. greetings Andi |
||||||||||||||||||||||||||||||||||||||||||
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
