Changes between Version 4 and Version 5 of TracQuery


Ignore:
Timestamp:
Sep 24, 2024, 8:58:05 AM (2 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracQuery

    v4 v5  
    22[[TracGuideToc]]
    33
    4 In addition to [TracReports reports], Trac provides ''custom ticket queries'', which display tickets meeting specified criteria. 
     4In addition to [TracReports reports], Trac provides ''custom ticket queries'', which display tickets meeting specified criteria.
    55
    66To configure and execute a custom query, navigate to the ''View Tickets'' module from the navigation bar, and select the ''New Custom Query'' link.
    … …  
    1313 * If not logged in and no name/email is defined in the preferences, then all open issues.
    1414
    15 New filters are added using the dropdown lists at the bottom corners of the filters box; 'And' conditions on the left, 'Or' conditions on the right. Filters are removed by clicking the button to the left with the minus sign on the label. 
     15New filters are added using the dropdown lists at the bottom corners of the filters box; 'And' conditions on the left, 'Or' conditions on the right. Filters are removed by clicking the button to the left with the minus sign on the label.
    1616
    1717After you have edited your filters, click the ''Update'' button to refresh your results.
    … …  
    3232== Navigating Tickets
    3333
    34 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. 
     34Clicking 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.
    3535
    36 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. If '''a new ticket matching the query criteria has been created''', it will be shown in bold. 
     36You 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. If '''a new ticket matching the query criteria has been created''', it will be shown in bold.
    3737
    3838The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    … …  
    4343You can also save references to queries in Wiki content, as described below.
    4444
    45 '''Note:''' one way to easily build queries like the ones below is to create and test the queries using Custom Query module. Clicking ''Save query'' will display the query string for you, all you need to do is remove the extra line breaks.
     45'''Note:''' One way to easily build queries like the ones below is to create and test the queries using Custom Query module. Clicking ''Save query'' will display the query string for you, all you need to do is remove the extra line breaks.
    4646
    47 '''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.
     47'''Note:''' You must have the `REPORT_CREATE` permission 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.
    4848
    4949== TracLinks to Queries
    … …  
    5151You can make a link to a query from any Wiki page using a simple [TracQuery#QueryLanguage query language] to specify the criteria.
    5252{{{
    53 [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
     53[query:status=new|assigned|reopened&version=1.4 Active tickets against 1.4]
    5454}}}
    5555
    5656Which is displayed as:
    57   [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
     57  [query:status=new|assigned|reopened&version=1.4 Active tickets against 1.4]
    5858
    5959Alternatively, you can copy the query string from the browser URL box and paste it into the Wiki link, including the leading `?` character:
    … …  
    6767== Query Language
    6868
    69 The `query:` TracLinks and the [TicketQuery "[[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. Multiple values are separated using a pipe (`|`), meaning the filter matches any of the values. To include a literal `&` or `|` in a value, escape the character with a backslash (`\`).
     69The `query:` TracLinks and the [TicketQuery "[[TicketQuery]]"] macro both use a mini “query language” for specifying query filters. Filters are separated by ampersands (`&`), the `[[TicketQuery]]` macro additionally also accepts commas (`,`). Each filter consists of the ticket field name, an operator and one or more values. Multiple values are separated using a pipe (`|`), meaning the filter matches any of the values. To include a literal `&` or `|` in a value, escape the character with a backslash (`\`).
    7070
    7171The available operators are:
    … …  
    8181|| '''`!$=`''' || the field content does not end with any of the values ||
    8282
    83 Filters combining matches and negated matches can be constructed for text fields such as Keywords and CC 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`.
     83Filters combining matches matches can be constructed for text fields such as Keywords and CC using the //contains// (`~=`) operator.
     84The `!` operator is used to negate a match.
     85
     86Note that for `query:` the match operator `=` needs to be on first position when combined with other operators, for example `=!` or `=~`. The `[[TicketQuery]]` macro on the other side accepts both syntax variants, for example `!=` or `~=` as well as `=!` or `=~`.
     87
     88Double quotes (//since Trac 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`.
     89
    8490|| '''`status=closed,keywords~=firefox`''' || query closed tickets that contain keyword `firefox` ||
    8591|| '''`status=closed,keywords~=opera`''' || query closed tickets that contain keyword `opera` ||
    … …  
    9096|| '''`status=closed,keywords~=opera -firefox`''' || query closed tickets that contain keyword `opera`, but no `firefox` ||
    9197
    92 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.
    93 || '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 ||
     98The date fields `created` and `modified` and custom fields of type `time` 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.
     99|| '''`created=2017-01-01..2018-01-01`''' || query tickets created in 2017 ||
    94100|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month ||
    95101|| '''`modified=1weekago..`''' || query tickets that have been modified in the last week ||