Changes between Version 2 and Version 3 of TracQuery


Ignore:
Timestamp:
2017-08-28T06:33:43Z (3 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracQuery

    v2 v3  
    1 = Trac Ticket Queries =
     1= Trac Ticket Queries
    22[[TracGuideToc]]
    33
    4 In addition to [wiki:TracReports reports], Trac provides support for ''custom ticket queries'', used to display lists of tickets meeting a specified set of criteria.
     4In addition to [wiki:TracReports reports], Trac provides support for ''custom ticket queries'', which can be used to display tickets that meet specified criteria.
    55
    66To configure and execute a custom query, switch to the ''View Tickets'' module from the navigation bar, and select the ''Custom Query'' link.
    77
    8 == Filters ==
    9 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.
     8== Filters
     9
     10When you first go to the query page, the default filter will display tickets relevant to you:
     11 * If logged in then all open tickets, it will display open tickets assigned to you.
     12 * 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.
     13 * If not logged in and no name/email is defined in the preferences, then all open issues are displayed.
     14
     15Current 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.
     16
     17For text fields such as Keywords and CC the `-` operator can be used to negate a match and double quotes (//since 1.2.1//) can be used to match a phrase. For example, a //contains// match for `word1 word2 -word3 "word4 word5"` matches tickets containing `word1` and `word2`, not `word3` and `word4 word5`.
    1018
    1119You 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.
    1220
    13 Once you've edited your filters click the ''Update'' button to refresh your results.
     21After you have edited your filters, click the ''Update'' button to refresh your results.
    1422
    15 == Navigating Tickets ==
    16 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. 
     23Keyboard shortcuts are available for manipulating the //checkbox// filters:
     24* Clicking on a filter row label toggles all checkboxes.
     25* Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
     26* Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter. Since 1.2.1 this also works for the //Columns// checkboxes.
    1727
    18 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 was edited'' will be displayed with italicized text.  If one of the tickets was edited such that [[html(<span style="color: grey">it no longer matches the query criteria </span>)]] the text will also be greyed. Lastly, if '''a new ticket matching the query criteria has been created''', it will be shown in bold.
     28The modifier key is platform and browser dependent. On Mac the modified key is !Option/Alt or Command. On Linux the modifier key is Ctrl + Alt. Opera on Windows seems to use Ctrl + Alt, while Alt is effective for other Windows browsers.
     29
     30== Navigating Tickets
     31
     32Clicking 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. 
     33
     34You 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 [[html(<span style="color: grey">it no longer matches the query criteria </span>)]], the text will also be greyed. Lastly, if '''a new ticket matching the query criteria has been created''', it will be shown in bold.
    1935
    2036The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    2137
    22 == Saving Queries ==
     38== Saving Queries
    2339
    24 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.
     40Trac 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.
     41You can also save references to queries in Wiki content, as described below.
    2542
    26 === Using TracLinks ===
     43'''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.
    2744
    28 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.
     45'''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.
     46
     47=== Using TracLinks
     48
     49You 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.
    2950{{{
    3051[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
    31 
    3252}}}
    3353
     
    3555  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
    3656
    37 This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]).
     57This uses a very simple query language to specify the criteria, see [wiki:TracQuery#QueryLanguage Query Language].
    3858
    3959Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading `?` character:
    4060{{{
    4161[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    42 
    4362}}}
    4463
     
    4665  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    4766
    48 === Using the `[[TicketQuery]]` Macro ===
     67=== Customizing the ''table'' format
    4968
    50 The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
    51 
    52 Example:
     69You 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:
    5370{{{
    54 [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
     71[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    5572}}}
    5673
    5774This is displayed as:
    58   [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
     75[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    5976
    60 Just like the [wiki:TracQuery#UsingTracLinks query: wiki links], the parameter of this macro expects a query string formatted according to the rules of the simple [wiki:TracQuery#QueryLanguage ticket query language].
     77==== Full rows
    6178
    62 A more compact representation without the ticket summaries is also available:
     79In ''table'' format you can also have full rows by using ''rows=<field>'':
    6380{{{
    64 [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    65 
     81[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    6682}}}
    6783
    6884This is displayed as:
    69   [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
     85[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    7086
    71 Finally if you wish to receive only the number of defects that match the query using the ``count`` parameter.
     87== Query Language
    7288
    73 {{{
    74 [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    75 
    76 }}}
    77 
    78 This is displayed as:
    79   [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    80 
    81 
    82 === Query Language ===
    83 
    84 `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.
     89`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 (`\`).
    8590
    8691The available operators are:
    87 || '''=''' || the field content exactly matches the one of the values ||
    88 || '''~=''' || the field content contains one or more of the values ||
    89 || '''!^=''' || the field content starts with one of the values ||
    90 || '''$=''' || the field content ends with one of the values ||
     92|| '''`=`''' || the field content exactly matches one of the values ||
     93|| '''`~=`''' || the field content contains one or more of the values ||
     94|| '''`^=`''' || the field content starts with one of the values ||
     95|| '''`$=`''' || the field content ends with one of the values ||
    9196
    9297All of these operators can also be negated:
    93 || '''!=''' || the field content matches none of the values ||
    94 || '''!~=''' || the field content does not contain any of the values ||
    95 || '''!!^=''' || the field content does not start with any of the values ||
    96 || '''!$=''' || the field content does not end with any of the values ||
     98|| '''`!=`''' || the field content matches none of the values ||
     99|| '''`!~=`''' || the field content does not contain any of the values ||
     100|| '''`!^=`''' || the field content does not start with any of the values ||
     101|| '''`!$=`''' || the field content does not end with any of the values ||
     102
     103Filters combining matches and negated matches can be constructed for text fields such as Keywords and CC when using the //contains// (`~=`) operator. The `-` operator is used to negate a match and double quotes (//since 1.2.1//) are used for whitespace-separated words in a phrase. For example, `keywords~=word1 word2 -word3 "word4 word5"` matches tickets containing `word1` and `word2`, not `word3` and also `word4 word5`.
     104|| '''`status=closed,keywords~=firefox`''' || query closed tickets that contain keyword `firefox` ||
     105|| '''`status=closed,keywords~=opera`''' || query closed tickets that contain keyword `opera` ||
     106|| '''`status=closed,keywords~=firefox opera`''' || query closed tickets that contain keywords `firefox` and `opera` ||
     107|| '''`status=closed,keywords~=firefox|opera`''' || query closed tickets that contain keywords `firefox` or `opera` ||
     108|| '''`status=closed,keywords~=firefox,or,keywords~=opera`''' || query closed tickets that contain keyword `firefox`, or (closed or unclosed) tickets that contain keyword `opera` ||
     109|| '''`status=closed,keywords~=firefox -opera`''' || query closed tickets that contain keyword `firefox`, but not `opera` ||
     110|| '''`status=closed,keywords~=opera -firefox`''' || query closed tickets that contain keyword `opera`, but no `firefox` ||
     111
     112The 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.
     113|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
     114|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month ||
     115|| '''`modified=1weekago..`''' || query tickets that have been modified in the last week ||
     116|| '''`modified=..30daysago`''' || query tickets that have been inactive for the last 30 days ||
     117
     118Note that `modified` is the //last modified time//, so `modified` with a date range shows ticket that were //last modified// in that date range. If a ticket was modified in the date range, but modified again after the end date, it will not be included in the results.
    97119
    98120----
    99 See also: TracTickets, TracReports, TracGuide
     121See also: TracTickets, TracReports, TracGuide, TicketQuery