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

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

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. This also allows displaying the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

#123
autoload malfunction

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#350 invalid Error while building from source moo ilantipov
#349 fixed wired name of directory moo ilantipov
#348 fixed Class properties created from __FILE__ break multi sites moo steveh
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 305)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#350 invalid Error while building from source moo ilantipov
Description

xcache version: xcache-3.1.1 php version: PHP 5.6.0 make version: GNU Make 3.81 OS Ubuntu 14.04.1 LTS

root@srv4 /usr/local/src/xcache-3.1.1 # phpize Configuring for: PHP Api Version: 20131106 Zend Module Api No: 20131226 Zend Extension Api No: 220131226 root@srv4 /usr/local/src/xcache-3.1.1 # ./configure --enable-xcache checking for grep that handles long lines and -e... /bin/grep checking for egrep... /bin/grep -E checking for a sed that does not truncate output... /bin/sed checking for cc... cc checking whether the C compiler works... yes checking for C compiler default output file name... a.out checking for suffix of executables... checking whether we are cross compiling... no checking for suffix of object files... o checking whether we are using the GNU C compiler... yes checking whether cc accepts -g... yes checking for cc option to accept ISO C89... none needed checking how to run the C preprocessor... cc -E checking for icc... no checking for suncc... no checking whether cc understands -c and -o together... yes checking for system library directory... lib checking if compiler supports -R... no checking if compiler supports -Wl,-rpath,... yes checking build system type... x86_64-unknown-linux-gnu checking host system type... x86_64-unknown-linux-gnu checking target system type... x86_64-unknown-linux-gnu checking for PHP prefix... /usr/local/php-fpm checking for PHP includes... -I/usr/local/php-fpm/include/php -I/usr/local/php-fpm/include/php/main -I/usr/local/php-fpm/include/php/TSRM -I/usr/local/php-fpm/include/php/Zend -I/usr/local/php-fpm/include/php/ext -I/usr/local/php-fpm/include/php/ext/date/lib checking for PHP extension directory... /usr/local/php-fpm/lib/php/extensions/no-debug-non-zts-20131226 checking for PHP installed headers prefix... /usr/local/php-fpm/include/php checking if debug is enabled... no checking if zts is enabled... no checking for re2c... no configure: WARNING: You will need re2c 0.13.4 or later if you want to regenerate PHP parsers. checking for gawk... gawk checking for XCache support... yes, shared checking for XCache handle of compile time constant... yes checking for XCache optimizer... no checking for XCache coverager... no checking for XCache assembler... no checking for XCache disassembler... no checking for XCache encoder... no checking for XCache decoder... no checking for XCache self test... no checking for XCache self test... no checking for gawk... /usr/bin/gawk checking for m4... /usr/bin/m4 checking for grep... (cached) /bin/grep checking for sed... /bin/sed checking for indent... no checking for cat... /bin/cat checking for ld used by cc... /usr/bin/ld checking if the linker (/usr/bin/ld) is GNU ld... yes checking for /usr/bin/ld option to reload object files... -r checking for BSD-compatible nm... /usr/bin/nm -B checking whether ln -s works... yes checking how to recognize dependent libraries... pass_all checking for ANSI C header files... yes checking for sys/types.h... yes checking for sys/stat.h... yes checking for stdlib.h... yes checking for string.h... yes checking for memory.h... yes checking for strings.h... yes checking for inttypes.h... yes checking for stdint.h... yes checking for unistd.h... yes checking dlfcn.h usability... yes checking dlfcn.h presence... yes checking for dlfcn.h... yes checking the maximum length of command line arguments... 1572864 checking command to parse /usr/bin/nm -B output from cc object... ok checking for objdir... .libs checking for ar... ar checking for ranlib... ranlib checking for strip... strip checking if cc supports -fno-rtti -fno-exceptions... no checking for cc option to produce PIC... -fPIC checking if cc PIC flag -fPIC works... yes checking if cc static flag -static works... yes checking if cc supports -c -o file.o... yes checking whether the cc linker (/usr/bin/ld -m elf_x86_64) supports shared libraries... yes checking whether -lc should be explicitly linked in... no checking dynamic linker characteristics... GNU/Linux ld.so checking how to hardcode library paths into programs... immediate checking whether stripping libraries is possible... yes checking if libtool supports shared libraries... yes checking whether to build shared libraries... yes checking whether to build static libraries... no

creating libtool appending configuration tag "CXX" to libtool configure: creating ./config.status config.status: creating config.h root@srv4 /usr/local/src/xcache-3.1.1 # make && make test && make install cc -I. -I/usr/local/src/xcache-3.1.1 -DPHP_ATOM_INC -I/usr/local/src/xcache-3.1.1/include -I/usr/local/src/xcache-3.1.1/main -I/usr/local/src/xcache-3.1.1 -I/usr/local/php-fpm/include/php -I/usr/local/php-fpm/include/php/main -I/usr/local/php-fpm/include/php/TSRM -I/usr/local/php-fpm/include/php/Zend -I/usr/local/php-fpm/include/php/ext -I/usr/local/php-fpm/include/php/ext/date/lib -DHAVE_CONFIG_H -g -O2 -E /usr/local/src/xcache-3.1.1/includes.c -o ./includes.i ./structinfo.m4 is optional if XCache test is not enabled, feel free if it awk failed to produce it LANG=C /usr/bin/gawk -f /usr/local/src/xcache-3.1.1/gen_structinfo.awk < ./includes.i > ./structinfo.m4.tmp && mv ./structinfo.m4.tmp ./structinfo.m4 /usr/bin/m4 -B 102400 -D srcdir=''"/usr/local/src/xcache-3.1.1'" -D builddir=''".'" /usr/local/src/xcache-3.1.1/processor/main.m4 > ./processor.out.c.tmp /usr/bin/m4: warning: `m4 -B' may be removed in a future release AUTOCHECK INFO: runtime autocheck Disabled (optimized build) AUTOCHECK INFO: zend_compiled_variable: processor looks good AUTOCHECK INFO: zend_try_catch_element: processor looks good AUTOCHECK INFO: zend_brk_cont_element: processor looks good AUTOCHECK INFO: HashTable?: processor looks good AUTOCHECK INFO: zval: processor looks good AUTOCHECK ERROR: ==== calc zend_arg_info ================= AUTOCHECK expected: "name","name_len","class_name","class_name_len","type_hint","pass_by_reference","allow_null","is_variadic" AUTOCHECK missing : "is_variadic" AUTOCHECK INFO: zend_constant: processor looks good AUTOCHECK INFO: zend_property_info: processor looks good AUTOCHECK INFO: zend_trait_method_reference: processor looks good AUTOCHECK INFO: zend_trait_alias: processor looks good AUTOCHECK INFO: zend_trait_precedence: processor looks good AUTOCHECK ERROR: ==== calc zend_class_entry ================= AUTOCHECK expected: "type","name","name_length","parent","refcount","ce_flags","function_table","properties_info","default_properties_table","default_static_members_table","static_members_table","constants_table","default_properties_count","default_static_members_count","constructor","destructor","clone","get","set","unset","isset","call","callstatic","tostring","debugInfo","serialize_func","unserialize_func","iterator_funcs","create_object","get_iterator","interface_gets_implemented","get_static_method","serialize","unserialize","interfaces","num_interfaces","traits","num_traits","trait_aliases","trait_precedences","info" AUTOCHECK missing : "debugInfo" AUTOCHECK INFO: znode: processor looks good AUTOCHECK INFO: zend_op: processor looks good AUTOCHECK INFO: zend_literal: processor looks good AUTOCHECK INFO: zend_op_array: processor looks good AUTOCHECK INFO: xc_constinfo_t: processor looks good AUTOCHECK INFO: xc_op_array_info_detail_t: processor looks good AUTOCHECK INFO: xc_op_array_info_t: processor looks good AUTOCHECK INFO: xc_funcinfo_t: processor looks good AUTOCHECK INFO: xc_classinfo_t: processor looks good AUTOCHECK INFO: xc_autoglobal_t: processor looks good AUTOCHECK INFO: xc_compilererror_t: processor looks good AUTOCHECK INFO: xc_entry_data_php_t: processor looks good AUTOCHECK INFO: xc_entry_t: processor looks good AUTOCHECK INFO: xc_entry_php_t: processor looks good AUTOCHECK INFO: xc_entry_var_t: processor looks good AUTOCHECK ERROR: ==== store zend_arg_info ================= AUTOCHECK ERROR: ==== store zend_class_entry ================= AUTOCHECK ERROR: ==== restore zend_arg_info ================= AUTOCHECK ERROR: ==== restore zend_class_entry ================= AUTOCHECK ERROR: ==== dprint zend_arg_info ================= AUTOCHECK ERROR: ==== dprint zend_class_entry ================= AUTOCHECK ERROR: ==== dasm zend_arg_info ================= AUTOCHECK ERROR: ==== dasm zend_class_entry ================= make: * [processor.out.c] Error 1

Maybe this error happens because it doesn't have to work with php 5.6, but I guess you must give more information about an error.

#349 fixed wired name of directory moo ilantipov
Description

After I do tar xzf xcache-3.1.1.tar.gz I get directory "3.1.1" Usually there is directory like xcache-3.1.1. Please repack it to behave as expected. I was lucky to install it on a clean server so I could easily find that directory

And add version 3.1.1 to version selection window here :)

#348 fixed Class properties created from __FILE__ break multi sites moo steveh
Description

If you have a class which uses FILE to initialise a property and said class is used on multiple sites xcache caches the value and hence its incorrect for all but the first site accessed.

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

Last modified 17 months ago Last modified on 2013-05-22T09:31:17+02:00