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

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:

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:

No results

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:

No results

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:

0

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

Ticket	Resolution	Summary	Owner	Reporter
#288	fixed	User registration broken		slinkp
#286	fixed	convert_to_block=True passed to full_geocode has a few problems		kmtracey
#282	fixed	Pagination on place_detail page can skip items		slinkp

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

Ticket	Resolution	Summary	Owner	Reporter
#288	fixed	User registration broken		slinkp
Reported by slinkp, 7 weeks ago.
Description	Enter email address to register Click confirmation link Submit password entry form. Kaboom. AttributeError at /accounts/c/ 'User' object has no attribute 'backend' Traceback: File "/var/www/demo.openblockproject.org/current/lib/python2.6/site-packages/django/core/handlers/base.py" in get_response 111. response = callback(request, *callback_args, **callback_kwargs) File "/var/www/demo.openblockproject.org/builds/20110815/src/openblock/ebpub/ebpub/accounts/views.py" in confirm_email 237. utils.login(request, u) File "/var/www/demo.openblockproject.org/builds/20110815/src/openblock/ebpub/ebpub/accounts/utils.py" in login 89. return auth.login(request, user) File "/var/www/demo.openblockproject.org/current/lib/python2.6/site-packages/django/contrib/auth/__init__.py" in login 82. request.session[BACKEND_SESSION_KEY] = user.backend
#286	fixed	convert_to_block=True passed to full_geocode has a few problems		kmtracey
Reported by kmtracey, 8 weeks ago.
Description	This code:  https://github.com/openplans/openblock/blob/master/ebpub/ebpub/geocoder/base.py#L498 runs into a few problems when convert_to_block is True. Seems it's been copied from somewhere else but not fully adapted. For easier reference the code is: except InvalidBlockButValidStreet, e: # If the exact address couldn't be geocoded, try using the # normalized location name. if convert_to_block: block_name = address_to_block(kwargs['location_name']) if block_name != kwargs['location_name']: try: result = BlockGeocoder._do_geocode(block_name) result['result']['address'] = block_name except InvalidBlockButValidStreet, another_e: pass except AmbiguousResult, another_e: pass # No joy, return all blocks. logger.debug('Invalid block for %r, returning all possible blocks' % query) return {'type': 'block', 'result': e.block_list, 'ambiguous': True, 'street_name': e.street_name, 'block_number': e.block_number} First we need a from ebpub.utils.text import address_to_block before using address_to_block, that's easy. I think kwargs['location_name'] needs to be replaced with query throughout. We need an instance of BlockGeocoder to call _do_geocode result['result']['address'] = block_name generates KeyError: 'result', I think that's maybe supposed to be result['address'] = block_name And in that case where we have a result it needs to be returned somehow?
#282	fixed	Pagination on place_detail page can skip items		slinkp
Reported by slinkp, 2 months ago.
Description	Place detail page does a sort of pagination by date; see eg.  http://demo.openblockproject.org/locations/zipcodes/02116/ and note the "older news" link at bottom. When there's a lot of news, the "older news" link can skip some items. Why: The page by default shows 7 days of news (or settings.DEFAULT_DAYS). At page bottom is an "older news" link. It links to the day before the last day shown on this page. That's fine if the page is showing all news within that date range. Problem is, the database query is also capped at constants.NUM_NEWS_ITEMS_PLACE_DETAIL, which is 300 by default. If you hit that cap before you get to the end of a day's worth of news, the rest of the news from that day will be skipped when you follow the link to the next day. Example: It's a busy week. Let's say that exactly 123 news items happened each day this week. (That's not unreasonably high; I've seen more than one scraper log hundreds of items in one zip code per day.) The place detail page for that zip code cuts off at 300 items. That's 123 items from the first day, 123 from the second day, and 54 from the third day. The link at bottom of page takes you to day before the last item shown - the fourth day. There are 46 items from the end of day 3 that are not shown on either page.

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 litteral & or | in a value, escape the character with a backslash (\).

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

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