wiki:TracQuery

Version 3 (modified by trac, 9 years ago) ( diff )

--

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.

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#83 fixed Upgrade to EPSG v9.0 rouault rouault
#81 fixed Build issues with #include <geo_config.h> (vs #include "geo_config.h") warmerdam rouault
#80 fixed Patch to add subdir-objects option warmerdam Bas Couwenberg
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 77)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#83 fixed Upgrade to EPSG v9.0 rouault rouault
Description

GDAL corresponding ticket: https://trac.osgeo.org/gdal/ticket/6772 proj.4: https://github.com/OSGeo/proj.4/issues/477

#81 fixed Build issues with #include <geo_config.h> (vs #include "geo_config.h") warmerdam rouault
Description

Reported by Sebastiaan Couwenberg in http://lists.maptools.org/pipermail/geotiff/2016-September/000816.html

Between RC2 and 1.4.2 final geotiff.h was changed to include
<geo_config.h> instead of "geo_config.h".

This causes the librasterlite2 configure to fail because it cannot find
geo_config.h any more, because the Debian package installs the geotiff
headers in /usr/include/geotiff instead of /usr/include.

I think the change should be reverted at least for geotiff.h, I'm not
sure if the change in cpl_serv.h should be reverted too.

These changes were committed in r2736 to fix build issues on Windows,
will reverting to #include "geo_config.h" reintroduce the build failures
on Windows? If so, we should probably deal with this in Debian by
specifying the custom include path used by the libgeotiff package."""

Charles Karney confirms that reverting to #include "geotiff.h" is OK for now :

Yes, this change (reverting to #include "geo_config.h" in 1.4.2) works
OK with Windows.  Here are the "" vs <> issues in this case:

Pro <>: If users mix in-source builds on one platform with out-of-source
builds on another platform, then "" will pick up the version of
geo_config.h for the wrong platform.  I notice that out-of-source
autoconf builds don't work for libgeotiff, potentially exacerabating
this problem.  (This should probably be fixed at some point.)  You might
argue that anyone doing such inter-leaved builds is asking for trouble.
(And, of course, removing geo_config.h from the source distribution
helped.)

Pro "": If a user of libgeotiff uses #include <libgeotiff/geotiff.h>,
then <> won't find geo_config.h in the same directory (unless the
preprocessor is also told -I/usr/include/libgeotiff).

The second point is potentially troublesome (as noted by Bas) since some
distributions install the include files in /usr/include/libgeotiff and
there's no definitive guidance as to whether to use

   -I/usr/include + #include <libgeotiff/geotiff.h>

or

   -I/usr/include/libgeotiff + #include <geotiff.h>

The current install policies for libgeotiff (cmake + autoconf) suggest
that the latter form is expected.  I would say that the former is a
better practice; unfortunately transitioning the installed base to this
convention would be difficult.  Compounding the problem, Debian and
Fedora choose different include directories (geotiff vs libgeotiff).

Short term, I recommend:

(1) revert to

   #include "geo_config.h"

(2) make out-of-source autoconf builds work

(3) document that in-source builds (either with cmake or autoconf) are
not supported (possibly even disable them).
#80 fixed Patch to add subdir-objects option warmerdam Bas Couwenberg
Description

Automake warns about the lack of the subdir-objects option:

Makefile.am:104: warning: source file 'csv/datum.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
automake: warning: possible forward-incompatibility.
automake: At least a source file is in a subdirectory, but the 'subdir-objects'
automake: automake option hasn't been enabled.  For now, the corresponding output
automake: object file(s) will be placed in the top-level directory.  However,
automake: this behaviour will change in future Automake versions: they will
automake: unconditionally cause object files to be placed in the same subdirectory
automake: of the corresponding sources.
automake: You are advised to start using 'subdir-objects' option throughout your
automake: project, to avoid future incompatibilities.
Makefile.am:104: warning: source file 'csv/ellipsoid.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/gcs.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/pcs.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/prime_meridian.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/projop_wparm.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/unit_of_measure.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled

Adding the option to AUTOMAKE_OPTIONS resolves the issue.

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

Note: See TracWiki for help on using the wiki.