Trac Ticket Queries
Table of Contents
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.
Navigating Tickets
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.
Using Trac Links
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:
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:
Using the [[TicketQuery]] Macro
The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use Wiki Formatting.
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, 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 414)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #2788 | resolvido | Escolher hotel oficial do evento | taniaa | taniaa |
| #2785 | resolvido | Orçamento - Verificar empresas de serviço de brigadista | rafahela | rafahela |
| #2784 | resolvido | Orçamento - Patubatê | rafahela | rafahela |
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 414)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #2788 | resolvido | Escolher hotel oficial do evento | taniaa | taniaa |
| Description |
Depois informar a Bancorbrás e colocar no site e redes sociais. |
|||
| #2785 | resolvido | Orçamento - Verificar empresas de serviço de brigadista | rafahela | rafahela |
| Description |
Enviado emails para Dinâmica e Griffo. |
|||
| #2784 | resolvido | Orçamento - Patubatê | rafahela | rafahela |
| Description |
---------- Mensagem encaminhada ---------- De: Rafahela Garcia Bazzanella <rafahela@gmail.com> Data: 5 de abril de 2013 15:08 Assunto: Re: Show em evento em Brasília Para: "fred@patubate.com" <fred@patubate.com> Cc: Diogo Baeder <diogobaeder@yahoo.com.br>, "contato@patubate.com" <contato@patubate.com>, "taniaa.moreira@gmail.com" <taniaa.moreira@gmail.com> Oi Fred! Eu trabalho com a Roberta Rabay, na Câmara dos Deputados. A Roberta é esposa do Marcelo Miranda que canta no Coral Brasília e foram eles que me indicaram vocês. Como o Diogo já introduziu, estamos organizando um evento internacional de tecnologia para outubro deste ano. Este evento já acontece há 11 anos mundo afora. Mas será a primeira vez que este será feito no hemisfério sul e como é no Brasil, gostaríamos de apresentar algo bem brasileiro para o pessoal que vem de fora. Aí pensamos em vocês! Vamos fazer uma festa de integração do pessoal do evento. Como ainda está um pouco longe, ainda não temos local fechado. Mas temos algumas sugestões. Até queremos passar nos locais para sabermos se atende o que queremos. Uma possibilidade é uma casa que abriu na frente do Liberty Mal, mas não conheço. A dinâmica da festa seria: reservamos um local em que cada um paga sua entrada/consumação e possa assistir a apresentação de vocês e de mais uma banda que tocaria toda a noite. Provavelmente terá cobrança de cover, onde cada um paga o seu. Vou te passar meu telefone 61-8432-5156, para conversarmos melhor e tirar suas dúvidas. Se preferir, posso ligar em um destes números que você passou: 9216-2662 e 7813-2945 Obrigada pelo contato, Rafahela Em 05-04-2013 11:50, Diogo Baeder escreveu: Oi, Fred, Faz um favor? Conversa com a Tania e a Rafahela, elas estão com informações mais precisas sobre o evento, pode ser? Estão em cópia neste e-mail. Abraços, Diogo Baeder http://diogobaeder.com.br ------------------------------------------------------------------------ *De:* "fred@patubate.com" <fred@patubate.com> *Para:* Diogo Baeder <diogobaeder@yahoo.com.br> *Cc:* contato@patubate.com *Enviadas:* Sexta-feira, 5 de Abril de 2013 11:41 *Assunto:* Re: Show em evento em Brasília Olá Diogo, tudo bem? Vc poderia me enviar um contato telefônico para que eu possa entender melhor o seu evento? Fico no seu aguardo. Um grande abraço! Fred Magalhães GRUPO PATUBATÊ www.patubate.com ( 61) 9216-2662 ( 61) 7813-2945 ID: 102 549*5 Citando Diogo Baeder <diogobaeder@yahoo.com.br <mailto:diogobaeder@yahoo.com.br>>: > Nome: Diogo Baeder > E-mail: diogobaeder@yahoo.com.br <mailto:diogobaeder@yahoo.com.br> > Assunto: Show em evento em Brasília > Estado: São Paulo > > > Mensagem: > Olá, > > O PloneGov-BR e a Associação Python Brasil estão organizando dois eventos, em Brasília, chamados PythonBrasil[9] (http://2013.pythonbrasil.org.br/) e PloneConf 2013 (http://2013.ploneconf.org/). Os dois eventos serão realizados em conjunto, e queremos emendar o evento em uma festa, no último dia. A festa será em uma casa noturna, e contaremos com a presença de, provavelmente, cerca de 350 pessoas. Parte destas pessoas seré composta de estrangeiros, portanto pensamos que seria interessante termos uma banda tocando na festa, mas que apresente sons característicos brasileiros (maracatu, ijexá etc). > > Para tanto, gostaria de saber se vocês têm um formato de show para este tipo de evento - visto que será em uma casa noturna, portanto provavelmente precisaremos de formato reduzido -. Se têm este formato, existe possibilidade de tocarem na festa? Se existe, como vocês trabalham em questão de pagamento: couvert artístico na portaria, ou preço fechado para apresentação? (No caso de preço fechado, nós provavelmente cobraríamos entrada na festa para cobrir o custo da banda.) > > Aguardo resposta, e um abraço, > > Diogo Baeder > > |
|||
Query Language
query: Trac Links 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: Trac Tickets, Trac Reports, Trac Guide
