wiki:TracQuery

Version 2 (modified by trac, 14 years ago) ( diff )

--

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:

#109
Main site: Newsbox only works for English language
#297
Create a new email list for LiveDVD discussions
#340
OSGeo4w trac instance has old logo
#361
Implement mailing list search (htdig, or likewise) on lists.osgeo.org
#501
OSGeo incubation for Orfeo Toolbox (OTB)
#547
Doxygen page not being updated by svn prior to being generated.
#805
Unable to reach upload.osgeo.org
#811
Failed to Transfer file Method Not Allowed
#813
Dutch Chapter list on Nabble
#815
Create project email list
#1002
SVN commit seems slower than normal
#1091
set up the rasdaman.osgeo.org sub domain
#1118
Broken Link: OSGeo-Live applications Presentation
#1322
FOSS sites down (2006/7/8/10/11)
#1324
openlayers.org is down
#1411
Correction to Service Provider Directory
#1496
Create Mailing list for OsGeo Nigeria
#1524
Archive of 2014 FOSS4g website
#1538
2014.foss4g.org - Error establishing a database connection
#1593
gvSIG international mailing list
#1594
gvSIG developers mailing list in Spanish
#1756
Update /osgeo_userid info about password reset
#1819
wiki configuration downlevel WRT security releases
#1839
Replace local Trac modification by proper component
#1923
Configure https etc for wordpress instance
#1924
Configure Wordpress Plugins per vendor
#1925
Configure Backup/Restore etc for Wordpress Instance
#1926
Configure LDAP and other Auth (google, github etc) for Wordpress Instance
#1927
Configure Group permissions for content management in Wordpress
#1976
problem with wiki requiring cookies even if they are already allowed
#2101
Redirect FOSS4G-Europe web page
#2139
Migrate wiki to use of OSGeo userid LDAP
#2157
Email list for OSGEO.us forming Chapter
#2194
provide blog posts on the new webside - activate the blog aggregator for the new website
#2224
provide Dropbox replacement for Board
#2335
Cannot upload artifacts via webdav
#2360
upgrade wiki to latest stuff
#2432
Create Matrix container on osgeo3
#2435
Please upgrade NextCloud
#2473
Verify email upon editing LDAP user
#2697
Dedicated lxd container for id.osgeo.org
#2745
Upgrade nextcloud from 22.2.5 to 23.0.3
#2984
Matrix to Libera Chat bridge
#2987
foss4g2019-workshops list can be closed - no more communication needed
#3083
Error 500 on gitea ssh/gpg keys

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:

#109, #297, #340, #361, #501, #547, #805, #811, #813, #815, #1002, #1091, #1118, #1322, #1324, #1411, #1496, #1524, #1538, #1593, #1594, #1756, #1819, #1839, #1923, #1924, #1925, #1926, #1927, #1976, #2101, #2139, #2157, #2194, #2224, #2335, #2360, #2432, #2435, #2473, #2697, #2745, #2984, #2987, #3083

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:

45

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#3168 fixed add tags to discourse sac-tickets@… toto71
#3167 fixed wordpress-dev is down sac-tickets@… robe
#3165 fixed photoprism.osgeo.org is down - did not come back after reboot sac-tickets@… robe
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 2914)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#3168 fixed add tags to discourse sac-tickets@… toto71
Description

spatialite, grass, saga, otb, whitebox

Thank you

#3167 fixed wordpress-dev is down sac-tickets@… robe
Description

Something seems to be wrong with wordpress-dev, seems to have shut down and starting it up wasn't getting an ip.

#3165 fixed photoprism.osgeo.org is down - did not come back after reboot sac-tickets@… robe
Description

As usual photoprism did not come back after reboot of osgeo7.

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.

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

Note: See TracWiki for help on using the wiki.