wiki:TracQuery

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 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 right 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.

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.

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

Ticket Resolution Summary Owner Reporter
#242 sistemata Il saldo non cambia in seguito a correzioni economiche effettuate con data antecedente fero
#241 sistemata Installazione pubblica su des macerata: operazioni impossibili nel box saldo del gas e dei gasisti kobe orly
#240 sistemata Errori Can't adapt su istallazione pubblica des macerata team sviluppo orly

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

Ticket Resolution Summary Owner Reporter
#242 sistemata Il saldo non cambia in seguito a correzioni economiche effettuate con data antecedente fero

Reported by fero, 8 days ago.

Description

Era ticket #241

Nel blocco "Saldo" della scheda "Conto" di un GAS ad esempio:  http://ordini.desmacerata.it/gasistafelice/rest/#rest/gas/11

effettuare una Spesa (-GAS) di 200 euro con data fine marzo.

Esempio di tale operazione già effettuata:

31857 lun 31 Mar 2014 00:00 DoGas? Correzione -200,00     OSI EXPENSE prova -Gas con data diversa
#241 sistemata Installazione pubblica su des macerata: operazioni impossibili nel box saldo del gas e dei gasisti kobe orly

Reported by orly, 11 days ago.

Description

All' interno del box saldo sia della scheda conto del gas che quella dei singoli gasisti non è più possibile effettuare alcune operazioni varie di aggiustamento economico, in entrambi i casi sulla console di firebug non sono evidenziati errori che vengono invece segnalati all' interno del sofware da notifiche su sfondo rosso:

nel caso del box saldo della scheda conto gasisti:

Transaction gasmember ERROR: Account matching query does not exist. verificabile ad esempio a questo link:  http://ordini.desmacerata.it/gasistafelice/rest/#rest/gasmember/675

ed effettuando una qualsiasi delle operazioni possibili (correzioni aggiunte ecc...)

nel caso invece del saldo della scheda conto del gas:

Transizione fattura ERROR: Account matching query does not exist.

questo però solo nel caso di aggiunta per Entrata: evento, donazione, sponsor, fondi... +GAS

come si può riprodurre a questo link:  http://ordini.desmacerata.it/gasistafelice/rest/#rest/gas/11/ed effettuando la suddetta operazione di aggiunta, mentre invece effettuando l'operazione di Spese utenze, conto bancario, amministrazione, eventi, affitto... -GAS questa ultima viene eseguita correttamente.

Inoltre nell' analogo box saldo della scheda patto tutte le operazioni avvengono regolarmente esempio:  http://ordini.desmacerata.it/gasistafelice/rest/#rest/pact/226

Infine nelle altre istallazioni sul server befair non vengono rilevati comportamenti analoghi e tutto procede regolarmente, sulla beta del des macerata non ho effettuato prove non essendo stata aggiornata.

#240 sistemata Errori Can't adapt su istallazione pubblica des macerata team sviluppo orly

Reported by orly, 11 days ago.

Description

Purtroppo questi errori di visualizzazione si estendono anche in altri settori del sofware come ad esempio nel paniere di tutti i gasisti e nel Report dell' ordine lasciando pensare a quanto già avvenuto con il  ticket228che si risolveva con aggiornamento di psycopg2 alla versione 2.5.2

La mancata visualizzazione del Report comporta il blocco dell' ordinazione non essendo possibile visualizzare i prodotti ordinati che sono tuttavia sicuramente presenti perchè dalla scheda Registrazione della stessa pagina è possibile visualizzarne l' importo totale e quello dettagliato dei singoli gasisti.

A differenza di quello segnalato in precedenza  ticket239 L'errore non è riportato dal software con nessun avviso del tipo: An error occurred while retrieving the data from server (error)

Ma è visibile solo dalla console di firebug come in questo esempio:

DatabaseError? at /gasistafelice/rest/order/7357/order_report/view

can't adapt

Request Method: GET Request URL:  http://ordini.desmacerata.it/gasistafelice/rest/order/7357/order_report/view?render_as=table&sEcho=1&iColumns=9&sColumns=&iDisplayStart=0&iDisplayLength=-1&mDataProp_0=0&mDataProp_1=1&mDataProp_2=2&mDataProp_3=3&mDataProp_4=4&mDataProp_5=5&mDataProp_6=6&mDataProp_7=7&mDataProp_8=8&sSearch=&bRegex=false&sSearch_0=&bRegex_0=false&bSearchable_0=true&sSearch_1=&bRegex_1=false&bSearchable_1=true&sSearch_2=&bRegex_2=false&bSearchable_2=false&sSearch_3=&bRegex_3=false&bSearchable_3=false&sSearch_4=&bRegex_4=false&bSearchable_4=false&sSearch_5=&bRegex_5=false&bSearchable_5=false&sSearch_6=&bRegex_6=false&bSearchable_6=false&sSearch_7=&bRegex_7=false&bSearchable_7=false&sSearch_8=&bRegex_8=false&bSearchable_8=false&iSortingCols=1&iSortCol_0=1&sSortDir_0=asc&bSortable_0=true&bSortable_1=true&bSortable_2=true&bSortable_3=false&bSortable_4=false&bSortable_5=false&bSortable_6=false&bSortable_7=false&bSortable_8=true&_=1396707360885 Django Version: 1.3.7 Exception Type: DatabaseError? Exception Value:

can't adapt

Exception Location: /var/lib/virtualenvs/gf_desmc/lib/python2.6/site-packages/django/db/backends/postgresql_psycopg2/base.py in execute, line 44 Python Executable: /var/lib/virtualenvs/gf_desmc/bin/python Python Version: 2.6.5 Python Path:

['/var/www/gf_desmc/gasistafelice',

'/var/lib/virtualenvs/gf_desmc/lib/python2.6/site-packages/setuptools-0.6c11-py2.6.egg','/var/lib/virtualenvs/gf_desmc/lib/python2.6/site-packages/pip-1.0-py2.6.egg','/var/lib/virtualenvs/gf_desmc/src/xhtml2pdf','/var/lib/virtualenvs/gf_desmc/src/django-pro-history','/var/lib/virtualenvs/gf_desmc/src/django-simple-accounting','/var/lib/virtualenvs/gf_desmc/src/django-flexi-auth','/var/lib/virtualenvs/gf_desmc/src/django-notification','/var/lib/virtualenvs/gf_desmc/lib/python2.6','/var/lib/virtualenvs/gf_desmc/lib/python2.6/plat-linux2','/var/lib/virtualenvs/gf_desmc/lib/python2.6/lib-tk','/var/lib/virtualenvs/gf_desmc/lib/python2.6/lib-old','/var/lib/virtualenvs/gf_desmc/lib/python2.6/lib-dynload','/usr/lib/python2.6','/usr/lib/python2.6/plat-linux2','/usr/lib/python2.6/lib-tk','/var/lib/virtualenvs/gf_desmc/lib/python2.6/site-packages','/usr/local/lib/python2.6/site-packages','/usr/local/lib/python2.6/dist-packages','/usr/lib/python2.6/dist-packages','/usr/lib/python2.6/dist-packages/PIL','/usr/lib/pymodules/python2.6','/usr/lib/pymodules/python2.6/gtk-2.0','/usr/lib/python2.6/dist-packages/wx-2.8-gtk2-unicode']

Server time: sab, 5 Apr 2014 16:14:11 +0200

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. To include a litteral & or | in a value, escape the character with a backslash (\).

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

The date fields created and modified can be constrained by using the = operator and specifying a value containing two dates separated by a semicolon (;). 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: TracTickets, TracReports, TracGuide