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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#12929 fixed Known users cache may not be invalidated when creating a session Ryan J Ollos Ryan J Ollos
Description

The case was missed in #11868. The known users cache will not be invalidated when creating a session without setting the name and email.

session = DetachedSession(self.env, sid)
session['authenticated'] = True
session.save()
#12924 fixed Eliminate EnvironmentSetup class Ryan J Ollos Ryan J Ollos
Description

Follow-on to #12891. At one time the EnvironmentSetup class contained a lot of code, but we've done a lot of refactoring since: EnvironmentSetup in Trac 1.0 vs EnvironmentSetup in Trac 1.3.2.

  1. I think it makes sense to eliminate the EnvironmentSetup class created in r1840 and implement IEnvironmentSetupParticipant on DatabaseManager.
  2. In r1840 the IEnvironmentSetupParticipant for attachments and templates were added, and the environment directories for attachments and templates were created in the IEnvironmentSetupParticipant.environment_created implementations. This was changed for attachments in r11169, but persists for templates. I think it's more clear to have all the top-level environment directories created in Environment.create.
#12923 fixed Form resubmission warning on page refresh after warning added when granting permission Ryan J Ollos Ryan J Ollos
Description

The issue appears to have been introduced in #3873 / r5227.

  • trac/admin/web_ui.py

    diff --git a/trac/admin/web_ui.py b/trac/admin/web_ui.py
    index acbbd22d5..5d1aad79c 100644
    a b class PermissionAdminPanel(Component):  
    389389                    add_notice(req, _("The subject %(subject)s has been "
    390390                                      "granted the permission %(action)s.",
    391391                                      subject=subject, action=action))
    392                     req.redirect(req.href.admin(cat, page))
    393392                else:
    394393                    add_warning(req, _("The permission %(action)s was already "
    395394                                       "granted to %(subject)s.",
    396395                                       action=action, subject=subject))
     396                req.redirect(req.href.admin(cat, page))
    397397
    398398            # Add subject to group
    399399            elif req.args.get('add') and subject and group:
    class PermissionAdminPanel(Component):  
    416416                    add_notice(req, _("The subject %(subject)s has been added "
    417417                                      "to the group %(group)s.",
    418418                                      subject=subject, group=group))
    419                     req.redirect(req.href.admin(cat, page))
    420419                else:
    421420                    add_warning(req, _("The subject %(subject)s was already "
    422421                                       "added to the group %(group)s.",
    423422                                       subject=subject, group=group))
     423                req.redirect(req.href.admin(cat, page))
    424424
    425425            # Remove permissions action
    426426            elif req.args.get('remove') and req.args.get('sel'):
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 8 years ago Last modified on Apr 10, 2010, 6:37:10 PM
Note: See TracWiki for help on using the wiki.