wiki:TracQuery
Last modified 3 months ago

Trac Ticket Queries

Table of Contents

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

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.

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, use 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 848)

Ticket Resolution Summary Owner Reporter
#1170 fixed Database upgrade should stop after first failure davea Eric Myers
#1169 fixed database upgrade may require alternate user davea Eric Myers
#1167 fixed Couldn't write state file; check directory permissions! FractalTS FractalTS

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

Ticket Resolution Summary Owner Reporter
#1170 fixed Database upgrade should stop after first failure davea Eric Myers

Reported by Eric Myers, 6 weeks ago.
Description

When the database is being upgraded the process should stop if any upgrade step fails. Right now if one SQL statement fails then the others that follow are still applied, which could leave the database in a confusing state, and the file db_revision is updated even if some or all of the upgrade steps failed.

There are several ways this could be accomplished. One is to first modify the do_query() function in db_update.php to use mysql_error() to check for a previous error and exit if there was one. The function becomes: 

function do_query($query) {
    if( $err = mysql_error() ) return $err;
    echo "Doing query:\n$query\n";
    $result = mysql_query($query);
    if (!$result) {
        echo "Failed:\n".mysql_error()."\n";
    } else {
        echo "Success.\n";
    }
}

This prevents further upgrade steps if one SQL query fails.

Similarly, the loop in upgrade_db.php which applies successive updates would check for any failures and exit the loop if one is found: 

foreach($updates as $update) {
    list($rev, $func) = $update;
    echo "performing update $func\n";
    call_user_func($func);
    if( mysql_errno() ) {
        echo "Database update failed.\n";
        break;
    }
     file_put_contents("../../db_revision", $rev);
}
#1169 fixed database upgrade may require alternate user davea Eric Myers

Reported by Eric Myers, 6 weeks ago.
Description

The database upgrade step should ask for a database username and password instead of assuming it should use the values in config.xml.

It may be the case that the default project db user listed does not have proper permissions to make changes to the database (add or drop tables or fields in tables), but only has permissions to insert, alter or remove entries. One would set such limited permissions to mitigate damage in the case of an intrusion via sql injection or something similar. But then the database upgrade will fail.

A simple way to avoid this problem is to have the db_update.php script invoke db_init_cli() instead of BoincDb::get_aux(false). This is appropriate because the file is to be run via CLI anyway. Here is a suggested patch: 

26,28c26,28
< if( $rc = db_init_cli() ){
<     if( $rc == 1 ) echo "Cannot connect to database server.\n";
<     if( $rc == 2 ) echo "Cannot select the database.\n";
---
> $db = BoincDb::get_aux(false);
> if (!$db) {
>     echo "Can't open database\n";

This doesn't catch the fact that the default db user cannot alter the database -- that is a separate problem -- but it lets the admin use a different db user that does have the proper permissions.

#1167 fixed Couldn't write state file; check directory permissions! FractalTS FractalTS

Reported by FractalTS, 7 weeks ago.
Description

I have been unable to launch (or restart) either project: Seti@Home or Einstein@Home within the BOINC Manager (version 6.12.34) for Windows XP.

I keep getting the error message (notice): "couldn't write state file; check directory permissions". but have no idea how to proceed?

According to the boinccmd file (running from a DOS prompt) - the "state file" is "corrupt" - so I have tried to INSTALL "REPAIR" - which is supposed to resolve that issue and INSTALL "REMOVE", followed by complete RE-INSTALL to fix the problem. But the problem persists!

Please help!

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

The available operators are:

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