wiki:TracQuery

Version 4 (modified by trac, 13 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:

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 using 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 2249)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2281 fixed File upload buttons should look like other buttons everyone Nicklas Nordborg
#2280 fixed Change history logging when editing project-specific annotations everyone Nicklas Nordborg
#2278 fixed Improvements to login page for better extensions everyone Nicklas Nordborg
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 2249)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2281 fixed File upload buttons should look like other buttons everyone Nicklas Nordborg
Description

The ability to style the button inside a file upload <input> element has been available for some time via the ::file-selector-button pseudo element. See https://caniuse.com/mdn-css_selectors_file-selector-button

Maybe it is possible to style the file upload buttons in BASE so they look like the other buttons.

#2280 fixed Change history logging when editing project-specific annotations everyone Nicklas Nordborg
Description

The change history logging include an entry for the currently active project. Typically, when a project-specific annotation is created or modified it is done for the current project and the existing entry is correct.

However, now that #2279 has been implemented, it is easy to change project-specific annotations also for other projects than the active one. This may seem a bit strange in the change history log.

It would be nice to be able to track the projects that the changed annotation values belong to. It is not possible to set a different active project since this is global setting for the entire transaction which may (in theory) include changes for more than one project. Instead, I think it is good enough to just add some information to the "change info" field. For example:

  • Annotation[Foobar (default)]: A change to the default value
  • Annotation[Foobar (My project)]: A change to the project-specific value for the "My project" project.
#2278 fixed Improvements to login page for better extensions everyone Nicklas Nordborg
Description

The login page can to some extents be modified by extensions but there are some improvements that can be made:

  1. The possibility to execute scripts before the login information is submitted. This could for example, be implemented as a custom event that is sent to the form before the form is submitted. Event handlers can do their processing and may also cancel the submission if needed.
  1. The possibility to add extra attributes to the login form and/or fields. We already have the DynamicActionsAttributes interface for this and it should be very easy to add support for it.
  1. The error message section should always be included in the HTML, but it should be hidden if there is no current message. Extensions should be able to display error messages.
  1. It should be possible to store session settings in the SessionControl even if a user is not logged in. This would, for example, be useful for the WebAuthn implementation (https://baseplugins.thep.lu.se/wiki/net.sf.basedb.webauthn) that need to store information between two requests.
  1. Scripts and style sheets that are added by extensions may interfere with each other. Since only one login form can be active it would be nice if only the scripts/style sheets defined by that extension are added to the page. When a different login form is selected the page is reloaded with the new scripts/style sheets.
  1. More...?
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