wiki:TracQuery

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

--

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1470 fixed Убрать "костыль, добавленный в r507/base и дублирующий ETag Denis_N alx
#1460 готово РЭ: предупреждение при прошивке плат ST-018, ST-116, ST-124, ST-018M, ST-116M, ST-124M прошивкой ревизии 0 Vladimir alx
#1456 готово РЭ: неверное описание графы "ppm" Vladimir alx
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>:

[[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 1258)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1470 fixed Убрать "костыль, добавленный в r507/base и дублирующий ETag Denis_N alx
Description

В r507/base была добавлена функция добвления ко всем ссылкам на статические файла CSS параметра v=xxxxxxxxx, формирующегося из времени модификации файла. В личной переписке разработчик пояснил, что данная мера призвана решить проблему, наблюдающуюся у пользователей, состоящую в том, что после обновления файла css на сервере браузер пользователя при загрузке страницы берет старую версию файла из своего кэша. Добавление же нового значения параметра в URI, по мнению разработчика, заставит браузер игнорировать кэшированный файл (так как URI нового файла теперь отличается от старого файла).

Насколько я понимаю, разработчик, фактически, "переизобрел" (и продублировал) ETag и связанный с ним механизм If-None-Match, который и так уже используется в системе (о существовании механизма If-None-Match разработчик не знал).

Проверка показала, что в ответ на запрос файла css сервер указывает в заголовке ответа Cache-Control: max-age:0, public. Судя по описанию этого параметра, max-age=0 предписывает браузеру всегда валидировать документ. Таким образом, во-первых, после обновления файла на сервере клиенты должны загружать новую версию файла и без каких-либо дополнительных усилий ("костылей"), а во-вторых, добавленная функция вряд ли может что-либо улучшить, так как она всего лишь дублирует уже имеющийся стандартный механизм валидации документов.

В личной переписке разработчик сообщил, что он не знает, как и почему у пользователей возникала проблема (почему браузер не загружал новую версию файла, а использовал устаревшую из кэша). Я понял так, что исследование проблемы не проводилось, причину проблемы разработчик выяснить не пытался, а просто добавил данный механизм (не зная, что аналогичный уже имеется) в надежде, что это поможет устранить проблему.

Учитывая сказанное выше, я предлагаю:

  1. Откатить коммит r507/base, так как он не добавляет ничего нового к уже имеющемуся стандартному механизму валидации, но, как минимум, зря загромождает код и вызывает ненужные вопросы при его чтении (как это произошло в моем случае).
  1. Попытаться разобраться с проблемой пользователей, а именно, выяснить, почему при загрузке страницы применяется устаревший файл стилей. Предполагалаю, что возможны самые разные причины, в том числе никак не связанные с нашей системой - ошибочная жалоба (файл загрузился новый, но пользователь ошибочно решил, что старый), "слишком агрессивное" (нарушающее стандарт, ошибочное) кэширование файла прокси-сервером, ошибочные настройки браузера, ошибка в браузере и т.п...
  1. После того как суть проблемы станет более-менее ясна - попытаться выработать соответствующее решение.

В свою очередь я готов оказывать помощь в меру своих сил и способностей.

#1460 готово РЭ: предупреждение при прошивке плат ST-018, ST-116, ST-124, ST-018M, ST-116M, ST-124M прошивкой ревизии 0 Vladimir alx
Description

В веб-интерфейсе аппаратуры MC04-DSL-3U при прошивке плат ST-018, ST-116, ST-124, ST-018M, ST-116M, ST-124M прошивкой ревизии 0 теперь выдается предупреждение о том, что прошивка платы такой прошивкой преобразует прошитую плату в плату другого типа, и пользователю предлагается выбор: нажать кнопку "Продолжить" или кнопку "Отмена". При нажатии "Продложить" прошивка прошивается в плату, при нажатии "Отмена" - не прошивается.

Вероятно, это следует описать в РЭ аппаратуры MC04-DSL-3U (я не знаю, нужно ли описывать это в РЭ, скорее просто информирую этим тикетом о сделанном изменении в веб-интерфейсе на случай если это нужно).

#1456 готово РЭ: неверное описание графы "ppm" Vladimir alx
Description

В РЭ аппаратуры MC04-DSL-3U редакции 80 в таблице 5.14 на странице 45 графа "ppm" описана следующим образом:

Отклонение частоты генератора в миллионных долях от номинальной частоты генератора.

Отклонение частоты генератора от номинальной частоты - это одна величина. Однако в графе "ppm" может отображаться сразу два разных значения (что видно даже на рисунке 5.13 того же РЭ). Следовательно, процитированное описание графы "ppm" в таблице неверно описывает смысл отображаемых в графе значений и не позволяет пользователю их правильно понять и интерпретировать.

Предлагаю скорректировать описание графы "ppm" таблицы состояния регенераторов в РЭ так, чтобы читателю был понятен смысл отображаемых в графе "ppm" значений.

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

Note: See TracWiki for help on using the wiki.