Changes between Version 4 and Version 5 of TracQuery


Ignore:
Timestamp:
Aug 10, 2016, 10:38:58 AM (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracQuery

    v4 v5  
    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.
    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.
    … …  
    1919After you have edited your filters, click the ''Update'' button to refresh your results.
    2020
    21 == Navigating Tickets ==
     21== Navigating Tickets
     22
    2223Clicking 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. 
    2324
    … …  
    2627The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    2728
    28 == Saving Queries ==
     29== Saving Queries
    2930
    3031Trac 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.
    3132You can also save references to queries in Wiki content, as described below.
    3233
    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.
     34'''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.
    3435
    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.
     36'''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.
    3637
    37 === Using TracLinks ===
     38=== Using TracLinks
    3839
    3940You 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.
    … …  
    5556  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    5657
    57 === Using the `[[TicketQuery]]` Macro ===
     58=== Customizing the ''table'' format
    5859
    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 ===
    9460You 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:
    9561{{{
    … …  
    10066[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    10167
    102 ==== Full rows ====
     68==== Full rows
     69
    10370In ''table'' format you can also have full rows by using ''rows=<field>'':
    10471{{{
    … …  
    10976[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    11077
    111 === Query Language ===
     78== Query Language
    11279
    11380`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 (`\`).
    … …  
    13299
    133100----
    134 See also: TracTickets, TracReports, TracGuide
     101See also: TracTickets, TracReports, TracGuide, TicketQuery