wiki:TracQuery

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 dropdown 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 dropdown 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 9)

1 2 3
Ticket Resolution Summary Owner Reporter
#10 fixed Zoltan's review of the document draft-ietf-imapmove-command@… alexey.melnikov@…
#9 fixed Clarify whether partial failure of MOVE/UID MOVE is allowed draft-ietf-imapmove-command@… alexey.melnikov@…
#8 fixed Updated text in the Abstract/Introduction draft-ietf-imapmove-command@… alexey.melnikov@…
1 2 3

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

1 2 3
Ticket Resolution Summary Owner Reporter
#10 fixed Zoltan's review of the document draft-ietf-imapmove-command@… alexey.melnikov@…
Description

In <http://www.ietf.org/mail-archive/web/imapext/current/msg04723.html> Zoltan wrote (I've removed most of the issues covered by other tickets):

General:

There are a good deal of abbreviations that are not spelled out on their first use (nor later on in the document).

Section 1: “Formal syntax is defined by [RFC5234].” I guess what you mean to say is that the formal syntax is defined using the ABNF notation defined in RFC5234.

Section 2: “This document defines an IMAP extension to move messages from one mailbox to another.” This document defines new IMAP commands to move messages?

Section 2: “This function (very common in MUA UIs) is not provided by stock IMAP ...” What is “stock imap”? One particular spec/product?

Section 2: “and cope with partial failures and side effects” What side effects? If you have a reference that discusses those, add it. If you don’t, remove it.

Section 3: “each message SHOULD either be moved or unaffected” I’d say MUST; there’s no third option. Section 3: “Implementers will need to read [RFC4315] to understand what UID

EXPUNGE does. Implementing [RFC4315] is not necessary.”

That sounds very awkward. Does it really make UIDPLUS a normative reference? Section 3: “ Note that moving messages to the current mailbox is well-defined, so

that MOVE is defined for all the cases where the COPY/STORE/EXPUNGE sequence is.”

This is not good enough, especially when ACLs are in use. Considering RFC4314 permissions:

  • COPY requires that I have ‘r’ right at the source and ‘i’ right at the destination.
  • STORE requires that I have ‘t’ right at the source.
  • EXPUNGE requires that I have ‘e’ right at the source.

Consequently, I must have ‘i’ at the destination and ‘r’+’t’+’e’ at the source. Section 4. This is a nice idea, but not quite future-proof. Were all extensions (at least those that are found in RFCs) enumerated to date? Section 4.2: “it requires the same ACL rights as the union of those three commands” The union of three commands is a command-triplet, not access rights. I think what you want to say is that the UID MOVE requires that all permissions that those three commands require if executed one-by-one. What about the MSN MOVE command? (this is clearly missing from this section) Section 5: “[RFC3501] defines the non-terminals "capability", "command", "set" and "mailbox".” You might want to change “command” to “command-select” (or, add command-select). Section 6: “ This document is believed to add no security problems.” Provided that the server does verify that all required permissions are in place. Section 6: “Problems with these algorithms can lead to mail loss.” You mean bad implementations of good algorithms, or just badly designed algorithms, right?

#9 fixed Clarify whether partial failure of MOVE/UID MOVE is allowed draft-ietf-imapmove-command@… alexey.melnikov@…
Description

Barry Leiba wrote in <http://www.ietf.org/mail-archive/web/imapext/current/msg04736.html>:

For each individual message ok. But should all the messages be either moved or none moved? Mainly should it fail and abort if some of the messages were already expunged? COPY is defined to either copy all or nothing. My MOVE implementation also moves all or nothing. But some people wanted to use rename() and such that would make reverting in the middle difficult.

I'm OK with saying that the action for each message must be well defined, but allow for a group MOVE to fail in the middle. We should verify the consensus on that point, though.

#8 fixed Updated text in the Abstract/Introduction draft-ietf-imapmove-command@… alexey.melnikov@…
Description

I suggest fixing the Overview as below, and then copying it verbatim into the Abstract. Also, please move the Abstract to be the first thing in the document, before the boilerplate. That matches the current I-D format. (It will also make it look less silly to have the Abstract and the Overview identical.)

If I understand you correctly, this has the effect of changing the Abstract from:

The MOVE extension provides commands to move one or more messages from the selected mailbox to a named mailbox.

to:

This document defines an IMAP extension to move messages from one mailbox to another. This function (very common in MUA UIs) is not provided by stock IMAP, and clients have to use a combination of UID STORE, UID COPY and EXPUNGE, and cope with partial failures and side effects.

The one thing this loses that was there before is the idea that this is done with new commands. In IMAP this is important because a lot of extensions add stuff to existing commands. I would therefore suggest a change to something like:

This document defines an IMAP extension consisting of two new commands, MOVE and UID MOVE, that are used to move messages from one mailbox to another. This function (very common in MUA UIs) is not provided by stock IMAP, and clients have to use a combination of UID STORE, UID COPY and EXPUNGE, and cope with partial failures and side effects.

1 2 3

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 6 years ago Last modified on 05/11/16 18:49:04