wiki:TracQuery
close Warning: Error with navigation contributor "AccountModule"

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, which can be used to display tickets that meet specified 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 in and no name/email is 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 on 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.

After you have edited your filters, click the Update button to refresh your results.

Some shortcuts can be used to manipulate checkbox filters.

  • Clicking on a filter row label toggles all checkboxes.
  • Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
  • Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter.

The modifier key is platform and browser dependent. On Mac the modified key is Option/Alt or Command. On Linux the modifier key is Ctrl + Alt. Opera on Windows seems to use Ctrl + Alt, while Alt is effective for other Windows browsers.

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.

Note: you must have the REPORT_CREATE permission in order to save queries to the list of default reports. The Save query button will only appear if you are logged in as a user that has been granted this permission. If your account does not have permission to create reports, you can still use the methods below to save a query.

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

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 in by placing pipes (|) between the columns:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 48)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#76 fixed "pwd" not working Achim J Latz
#75 fixed Restore times wrong, times on store correct ben Achim J Latz
#73 fixed International characters cannot be entered into bbackupquery chris chris
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>:

[[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 48)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#76 fixed "pwd" not working Achim J Latz
Description

"pwd" always returns "" for the current directory. Expected result (according to "help pwd": Print current directory, always root relative.)

#75 fixed Restore times wrong, times on store correct ben Achim J Latz
Description

Testing incremental backups with a file that is automatically updated every 10 minutes with the following batch file:

echo %date% %time% >> f:\root\timetest.txt

It appears that the times during which the file is backed up and to which the ctime/mtime is set during restore is not working correct:

Actual time of the backup according to the file's content (GMT +2):

Test 2: 07/09/2010 15:10:00,06 
Test 3: 07/09/2010 16:10:00,59 
Test 4: 07/09/2010 17:10:00,28 

This is consistent with the information shown in the bb store when using "list -T" (note the expected 2 hour GMT offset):

0000aa0c f--o-- 2010-09-07T13:10:02  00006 timetest.txt
0000aa0d f--o-- 2010-09-07T14:10:02  00006 timetest.txt
0000aa0e f--o-- 2010-09-07T15:10:02  00006 timetest.txt

However, after restoring those files, ctime/mtime shows a wrong offset to the store time (+10 GMT) and the local time (+8):

07/09/2010  23:10         2.816.941 test2.txt
08/09/2010  00:10         2.817.091 test3.txt
08/09/2010  01:10         2.817.241 test4.txt
#73 fixed International characters cannot be entered into bbackupquery chris chris
Description

When bbackupquery is linked to libedit, which seems to be the default on some Linux distributions (e.g. Debian and Ubuntu), it runs into a bug in libedit's support for international characters. libedit refuses to allow international characters to be entered at the prompt.

I've investigated the problem and I'm fairly confident (without debugging down to the exact lines in libedit) that this is the problem:

http://marc.info/?l=netbsd-users&m=119056066913928&w=2

Specifically, libedit "will have problems with UTF-8 and multibyte character sets, because it reads characters from the terminal one byte at a time, and checks them bytewise for printability."

This works on FreeBSD but not on Linux, due to differences in the locale tables. FreeBSD lists some of the bytes 0x80 to 0xfd as printable, which allows Unicode to be entered bytewise, wherease Linux does not, at least on by Ubuntu system. This causes libedit to reject the characters. So this bug probably affects Linux systems, but not FreeBSD.

I can't see modifying the locale tables as a useful workaround, and switching the character set to ISO-8859-1 also does not solve the problem (some characters can be entered, but others cannot). However you might find that the following is a partial workaround on your system:

LC_ALL=de_DE.ISO8859-1 bbackupquery ...

Another workaround is to use the command line to enter the directory that you want:

bbackupquery "cd location/path/with/umlauts-öäüÖÄÜß"

Otherwise, libedit needs to be disabled or fixed in order to properly support international characters, or readline must be used instead. Disabling it removes other functionality, so this is a difficult choice to make, but I think it makes sense to disable it (at least by default) on Linux systems.

Using readline was not previously an option because of license conflicts. I think that even though Box Backup is now dual-licensed, there may still be a conflict in linking both GPL readline and non-GPL OpenSSL into the same binary, so Debian probably would not accept a switch to readline as a solution.

I've looked into fixing libedit and it's definitely not trivial. I started to "look at the tcsh code (where the editline code was created from) and copy the changes," but the whole of tcsh was converted to use wide character strings at the same time, which would break backwards compatibility with existing applications if applied directly to libedit.

I'm considering adding a command-line switch to bbackupquery to disable readline/editline, and/or doing it automatically if the locale tables don't appear to support entering Unicode characters.

In the mean time I recommend that international users of bbackupquery build their binaries from source (rather than using their distribution's binary package) and link to readline instead of editline, by passing the --enable-gnu-readline option to the ./configure script, and treat the resulting binary as covered by the GPL alone.

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. Filters are separated by ampersands (&). Each filter 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 omitted 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, TicketQuery

Last modified 21 months ago Last modified on Feb 8, 2017, 9:29:28 PM