Please note that these Trac pages are no longer being updated. Wiki contents/documentation have moved to GitHub.

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

Ticket Resolution Summary Owner Reporter
#1420 fixed Advertisepipe.r2py could potentially launch many threads monzum monzum
#1419 fixed The advertising thread in advertisepipe.r2py may die, causing its functionality to stop. monzum monzum
#1418 fixed Add exception for when a listening TCP socket becomes invalid albert albert

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

Ticket Resolution Summary Owner Reporter
#1420 fixed Advertisepipe.r2py could potentially launch many threads monzum monzum

Reported by monzum, 5 years ago.

description

Currently when a new key-value pair is added to the pipe, the function start_advertise_thread() is called (L165).

The function start_advertise_thread() checks the number of threads running, and launches a new thread advertise_thread() if the number of thread is 0 (L219). However the variable

mycontext['advertisepipe_thread_count']

never gets incremented, which means start_advertise_thread() will always launch a new instance of advertise_thread(). The only exception is if one of the threads terminates and L123 is reached and the number of threads are decremented. This brings up a new problem. If only one thread is launched and it terminates, the counter will be set to -1. Which means no further thread will be launched, even if we add new key-value pair for advertisement.

#1419 fixed The advertising thread in advertisepipe.r2py may die, causing its functionality to stop. monzum monzum

Reported by monzum, 5 years ago.

description

The thread that is responsible for advertising the key-value pair may die due to unforeseen error being raised in the thread. This breaks the advertisepipe as we do not have any logic of restarting the advertise thread at the moment.

The library needs to be looked at to make it slightly more robust. One option is to have a second thread monitoring the advertisement thread. Another option would be to wrap the entire advertise thread in Try/Except block and try to handle any unexpected error from it.

#1418 fixed Add exception for when a listening TCP socket becomes invalid albert albert

Reported by albert, 5 years ago.

description

As discussed in the context of Affix, there should be an exception that is raised when a TCP server socket becomes invalid. This can happen with a "plain" socket if the IP address the socket was bound to isn't used anymore on any of the interfaces of a node; in the case of Affixes, it happens when the node uses a NAT forwarder because it cannot listen for incoming connections itself, and the connection to that forwarder is lost.

(Note that the Berkeley Socket API does not raise an error in this case. This makes sense for sockets that were not bound to a specific address -- entries with *.port-number in netstat -- as they will use any IP address available; sockets that were bound to a specific address silently become unusable, i.e. calling accept() on them will not return new connections unless a network interface uses the bound IP address again.)


We decided to call the new exception "TCPServerSocketInvalidError". I'm attaching a patch to the Repy exception hierarchy to add the new exception.

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