Changes between Version 2 and Version 3 of TracQuery


Ignore:
Timestamp:
25 Jan 2017, 21:56:44 (11 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 ==
     8== Filters
    99
    10 When 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 and no name/email defined in the preferences then all open issues are displayed.
     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.
    1414
    15 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.
     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 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.
    1616
    1717You 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.
    1818
    19 Once you've edited your filters click the ''Update'' button to refresh your results.
     19After you have edited your filters, click the ''Update'' button to refresh your results.
    2020
    21 == Navigating Tickets ==
    22 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. 
     21Some shortcuts can be used to manipulate //checkbox// filters.
     22* Clicking on a filter row label toggles all checkboxes.
     23* Pressing the modifier key while clicking on a filter row label inverts the state of all checkboxes.
     24* Pressing the modifier key while clicking on a checkbox selects the checkbox and deselects all other checkboxes in the filter.
    2325
    24 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 [[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.
     26The 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.
     27
     28== Navigating Tickets
     29
     30Clicking 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. 
     31
     32You 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.
    2533
    2634The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    2735
    28 == Saving Queries ==
     36== Saving Queries
    2937
    3038Trac 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.
    3139You can also save references to queries in Wiki content, as described below.
    3240
    33 ''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.
     41'''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.
    3442
    35 === Using TracLinks ===
     43'''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.
    3644
    37 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=== Using TracLinks
     46
     47You 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.
    3848{{{
    3949[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
     
    4353  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
    4454
    45 This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]).
     55This uses a very simple query language to specify the criteria, see [wiki:TracQuery#QueryLanguage Query Language].
    4656
    4757Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading `?` character:
     
    5363  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    5464
    55 === Using the `[[TicketQuery]]` Macro ===
     65=== Customizing the ''table'' format
    5666
    57 The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
    58 
    59 Example:
    60 {{{
    61 [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    62 }}}
    63 
    64 This is displayed as:
    65   [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    66 
    67 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].
    68 
    69 A more compact representation without the ticket summaries is also available:
    70 {{{
    71 [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    72 }}}
    73 
    74 This is displayed as:
    75   [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    76 
    77 Finally if you wish to receive only the number of defects that match the query using the ``count`` parameter.
    78 
    79 {{{
    80 [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    81 }}}
    82 
    83 This is displayed as:
    84   [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    85 
    86 === Customizing the ''table'' format ===
    87 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:
    88 
     67You 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:
    8968{{{
    9069[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
     
    9473[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    9574
    96 ==== Full rows ====
    97 In ''table'' format you can also have full rows by using ''rows=<field>'' like below:
     75==== Full rows
    9876
     77In ''table'' format you can also have full rows by using ''rows=<field>'':
    9978{{{
    10079[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
     
    10483[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    10584
     85== Query Language
    10686
    107 === Query Language ===
    108 
    109 `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 (`\`).
     87`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 (`\`).
    11088
    11189The available operators are:
    112 || '''`=`''' || the field content exactly matches the one of the values ||
     90|| '''`=`''' || the field content exactly matches one of the values ||
    11391|| '''`~=`''' || the field content contains one or more of the values ||
    11492|| '''`^=`''' || the field content starts with one of the values ||
     
    12199|| '''`!$=`''' || the field content does not end with any of the values ||
    122100
    123 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.
     101The 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.
    124102|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
    125103|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month ||
     
    128106
    129107----
    130 See also: TracTickets, TracReports, TracGuide
     108See also: TracTickets, TracReports, TracGuide, TicketQuery