wiki:TracQuery

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:

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#703 fixed External request lookup order issue kesara@staff.ietf.org kesara@staff.ietf.org
#701 fixed bibxml directory list doesn't include bibxml6 kesara@staff.ietf.org kesara@staff.ietf.org
#698 invalid –-allow-local-file-access defunct julian.reschke@gmx.de
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> 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 589)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#703 fixed External request lookup order issue kesara@staff.ietf.org kesara@staff.ietf.org
Description

When processing external request lookups, if the request is not an existing absolute path, xml2rfc must first look at the templates directory then fall back to the source directory.

At the moment when resolving an external resource such as

<!DOCTYPE rfc SYSTEM "rfc2629-xhtml.ent">

resolver logic is already presented with an absolute path like /<source dir absolute path>/rfc2629-xhtml.ent so xml2rfc treats rfc2629-xhtml.ent as an absolute path.

In scenarios where rfc2629-xhtml.ent file exists in the source directory, xml2rfc tries to access that file source directory instead of the rfc2629-xhtml.ent file in templates directory. This results in a local file access error because by default only files in the template directory can be accessed.

#701 fixed bibxml directory list doesn't include bibxml6 kesara@staff.ietf.org kesara@staff.ietf.org
Description

At the moment following bibxml directory locations are searched: 'bibxml', 'bibxml2', 'bibxml3', 'bibxml4', 'bibxml5'

This should include the bibxml6 directory.

#698 invalid –-allow-local-file-access defunct julian.reschke@gmx.de
Description
> xml2rfc elements.xml
Error: Can not access local file: /projects/xml2rfc/rfc2629-xhtml.ent
Error: Can not access local file: /projects/xml2rfc/rfc2629-xhtml.ent
Error: Unable to parse the XML document: elements.xml
 None: Line 0: Can not access local file: /projects/xml2rfc/rfc2629-xhtml.ent

So the new code is active.

But:

> xml2rfc –-allow-local-file-access elements.xml
usage: xml2rfc [OPTIONS] SOURCE [OPTIONS]...
Example: xml2rfc draft.xml -b draft-foo-19 --text --html
xml2rfc: error: unrecognized arguments: elements.xml
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 13 years ago Last modified on 14/01/10 23:05:01