Changes between Version 7 and Version 8 of TracQuery


Ignore:
Timestamp:
Jul 25, 2015, 7:08:55 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracQuery

    v7 v8  
    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:
     
    1919After you have edited your filters, click the ''Update'' button to refresh your results.
    2020
    21 == Navigating Tickets
    22 
     21== Navigating Tickets ==
    2322Clicking 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. 
    2423
     
    2726The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    2827
    29 == Saving Queries
     28== Saving Queries ==
    3029
    3130Trac 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.
    3231You can also save references to queries in Wiki content, as described below.
    3332
    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.
     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.
    3534
    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.
     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.
    3736
    38 === Using TracLinks
     37=== Using TracLinks ===
    3938
    4039You 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.
     
    5655  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    5756
    58 === Customizing the ''table'' format
     57=== Using the `[[TicketQuery]]` Macro ===
    5958
     59The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
     60
     61Example:
     62{{{
     63[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
     64}}}
     65
     66This is displayed as:
     67  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
     68
     69Just 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
     74This is displayed as:
     75  [[TicketQuery(id=123)]]
     76
     77A more compact representation without the ticket summaries is:
     78{{{
     79[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
     80}}}
     81
     82This is displayed as:
     83  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
     84
     85Finally, 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
     90This is displayed as:
     91  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
     92
     93=== Customizing the ''table'' format ===
    6094You 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:
    6195{{{
     
    66100[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
    67101
    68 ==== Full rows
    69 
     102==== Full rows ====
    70103In ''table'' format you can also have full rows by using ''rows=<field>'':
    71104{{{
     
    76109[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    77110
    78 == Query Language
     111=== Query Language ===
    79112
    80113`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 (`\`).
     
    99132
    100133----
    101 See also: TracTickets, TracReports, TracGuide, TicketQuery
     134See also: TracTickets, TracReports, TracGuide

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png