Edgewall Software

This page documents the 0.11 release. Documentation for other releases can be found here.

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 filters will display all open tickets, or if you're logged in it will display open tickets assigned to you. Current filters can be removed by clicking the button to the right with the minus sign on the label. New filters are added from the pulldown list in the bottom-right corner of the filters box. 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.

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

While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below.

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:

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

A more compact representation without the ticket summaries is also available:

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

Finally if you wish to receive only the number of defects that match the query using 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:

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13496 duplicate Uploading an attachment fails with "AssertionError: write() before start_response()" anonymous
Description

When adding an attachment to a wiki page (or just clicking the cancel button on the Add Attachment page) I get the error below in the browser (and in the Apache error log). No attachment is saved or added to the wiki page.

Trac version: 1.5.4dev from the trunk at revision 17603

OS: Fedora Server 34

Python version: 3.9.4

Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 572, in run
    protocolStatus, appStatus = self.server.handler(self)
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 1250, in handler
    write(b'') # in case body was empty
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 1203, in write
    assert headers_set, 'write() before start_response()'
AssertionError: write() before start_response()
#13492 fixed Uploading an attachment fails with "AssertionError: write() before start_response()" (mod_fcgid) Jun Omae arroz
Description

Running Trac 1.5.4.dev0 (0182158c5cb676af5b40cf1714c3d29c28a9d632 from the git repository). Not sure if the problem actually happens in 1.5.3, I need to be on trunk due to a different issue, so consider this 1.5dev (that version isn't available in the list).

When uploading an attachment to a ticket, I get the following error on the browser. This doesn't seem to depend on either the name or size of the attachment (a one byte file with a name with no special chars or spaces triggers the problem).

Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 572, in run
    protocolStatus, appStatus = self.server.handler(self)
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 1250, in handler
    write(b'') # in case body was empty
  File "/usr/local/lib/python3.9/site-packages/trac/web/_fcgi.py", line 1203, in write
    assert headers_set, 'write() before start_response()'
AssertionError: write() before start_response()
#13489 duplicate OperationalError: ambiguous column name: id admin
Description

How to Reproduce

While doing a GET operation on /query, Trac issued an internal error.

(please provide additional details here)

Request parameters:

{u'col': [u'id',
          u'summary',
          u'type',
          u'owner',
          u'doc_title',
          u'doc_revision',
          u'doc_revdate',
          u'doc_tag',
          u'doc_author',
          u'doc_reviewer',
          u'doc_approver'],
 u'group': u'status',
 u'order': u'priority',
 u'report': u'21',
 u'summary': u'~FSA101',
 u'type': [u'Document', u'WindchillDocument']}

User agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:103.0) Gecko/20100101 Firefox/103.0

System Information

Trac 1.2.3
Babel 1.3
Docutils 0.12
Genshi 0.7 (with speedups)
Pygments 2.1
pysqlite 2.6.0
Python 2.7.9 (default, Apr 2 2015, 15:33:21)
[GCC 4.9.2]
pytz 2014.10
setuptools 18.0.1
SQLite 3.11.0
Subversion 1.9.3 (r1718519)
jQuery 1.11.3
jQuery UI 1.11.4
jQuery Timepicker 1.5.5

Enabled Plugins

ExcelDownloadPlugin 0.12.0.6
KeepInterfaceSimple2Plugin 2.5
MultipleWorkflowPlugin 1.4.1
TicketImport 0.9.0
Tracchildtickets 2.5.6.dev0
TracCustomFieldAdmin 0.2.12
TracMasterTickets 4.0.2
TracMathJax 0.4
TracSQL 0.3
TracWysiwyg 0.12.0.7
WikiTableMacro 0.3.dev0

Interface Customization

shared-htdocs
shared-templates
site-htdocs Andar_logo_320_132.png, logo.png
site-templates site.html

Python Traceback

Traceback (most recent call last):
  File "build/bdist.linux-x86_64/egg/trac/web/main.py", line 647, in _dispatch_request
    dispatcher.dispatch(req)
  File "build/bdist.linux-x86_64/egg/trac/web/main.py", line 248, in dispatch
    resp = chosen_handler.process_request(req)
  File "build/bdist.linux-x86_64/egg/trac/ticket/query.py", line 1016, in process_request
    return self.display_html(req, query)
  File "build/bdist.linux-x86_64/egg/trac/ticket/query.py", line 1122, in display_html
    tickets = query.execute(req, cached_ids=orig_list)
  File "build/bdist.linux-x86_64/egg/trac/ticket/query.py", line 303, in execute
    self.num_items = self._count(sql, args)
  File "build/bdist.linux-x86_64/egg/trac/ticket/query.py", line 284, in _count
    % sql, args)[0][0]
  File "build/bdist.linux-x86_64/egg/trac/db/api.py", line 122, in execute
    return db.execute(query, params)
  File "build/bdist.linux-x86_64/egg/trac/db/util.py", line 128, in execute
    cursor.execute(query, params if params is not None else [])
  File "build/bdist.linux-x86_64/egg/trac/db/util.py", line 72, in execute
    return self.cursor.execute(sql_escape_percent(sql), args)
  File "build/bdist.linux-x86_64/egg/trac/db/sqlite_backend.py", line 88, in execute
    result = PyFormatCursor.execute(self, *args)
  File "build/bdist.linux-x86_64/egg/trac/db/sqlite_backend.py", line 64, in execute
    args or [])
  File "build/bdist.linux-x86_64/egg/trac/db/sqlite_backend.py", line 55, in _rollback_on_error
    return function(self, *args, **kwargs)
OperationalError: ambiguous column name: id
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. 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.

The available operators are:

= the field content exactly matches the 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

See also: TracTickets, TracReports, TracGuide

Last modified 12 years ago Last modified on Apr 10, 2010, 6:37:10 PM
Note: See TracWiki for help on using the wiki.