HAMcast developers

Changes between Version 2 and Version 3 of TracQuery


Ignore:
Timestamp:
04/13/18 13:55:00 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracQuery

    v2 v3  
    1 = Trac Ticket Queries =
     1= Trac Ticket Queries
    22[[TracGuideToc]]
    33
     
    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
    1010When you first go to the query page, the default filter will display tickets relevant to you:
     
    1313 * 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 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.
     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`.
    1618
    1719You 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.
     
    1921After you have edited your filters, click the ''Update'' button to refresh your results.
    2022
    21 == Navigating Tickets ==
     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.
     27
     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
    2232Clicking 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. 
    2333
     
    2636The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    2737
    28 == Saving Queries ==
     38== Saving Queries
    2939
    3040Trac 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.
    3141You can also save references to queries in Wiki content, as described below.
    3242
    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.
     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.
    3444
    35 ''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.
     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.
    3646
    37 === Using TracLinks ===
     47=== Using TracLinks
    3848
    3949You 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.
     
    5565  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    5666
    57 === Using the `[[TicketQuery]]` Macro ===
     67=== Customizing the ''table'' format
    5868
    59 The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
    60 
    61 Example:
    62 {{{
    63 [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    64 }}}
    65 
    66 This is displayed as:
    67   [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    68 
    69 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]. This also displays the link and description of a single ticket:
    70 {{{
    71 [[TicketQuery(id=123)]]
    72 }}}
    73 
    74 This is displayed as:
    75   [[TicketQuery(id=123)]]
    76 
    77 A more compact representation without the ticket summaries is:
    78 {{{
    79 [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    80 }}}
    81 
    82 This is displayed as:
    83   [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    84 
    85 Finally, if you wish to receive only the number of defects that match the query, use the `count` parameter:
    86 {{{
    87 [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    88 }}}
    89 
    90 This is displayed as:
    91   [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    92 
    93 === Customizing the ''table'' format ===
    9469You 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:
    9570{{{
     
    10075[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    10176
    102 ==== Full rows ====
     77==== Full rows
     78
    10379In ''table'' format you can also have full rows by using ''rows=<field>'':
    10480{{{
     
    10985[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    11086
    111 === Query Language ===
     87== Query Language
    11288
    11389`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 (`\`).
     
    125101|| '''`!$=`''' || the field content does not end with any of the values ||
    126102
     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
    127112The 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.
    128113|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
     
    131116|| '''`modified=..30daysago`''' || query tickets that have been inactive for the last 30 days ||
    132117
     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.
     119
    133120----
    134 See also: TracTickets, TracReports, TracGuide
     121See also: TracTickets, TracReports, TracGuide, TicketQuery