Changes between Version 9 and Version 10 of TracQuery


Ignore:
Timestamp:
Apr 22, 2012 6:18:46 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracQuery

    v9 v10  
    1  
    2  
    3  
    4  
    5  
    6  
    71= Trac Ticket Queries = 
    82[[TracGuideToc]] 
     
    137 
    148== Filters == 
    15 When you first go to the query page the default filters will display all open tickets, or if you're logged in it will display open tickets assigned to you.  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 list in the bottom-right corner of the filters box.  Filters with either a text box or a pulldown menu of options can be added multiple times to perform an ''or'' of the criteria. 
     9 
     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 and no name/email defined in the preferences then all open issues are displayed. 
     14 
     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'' of 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. 
     
    2222Clicking 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.   
    2323 
    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.  
     24You 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.  
    2525 
    2626The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again. 
     
    2828== Saving Queries == 
    2929 
    30 While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below. 
     30Trac 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. 
     31You can also save references to queries in Wiki content, as described below. 
     32 
     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. 
    3134 
    3235=== Using TracLinks === 
     
    3841 
    3942Which is displayed as: 
    40   [query:status=new|assigned|reopen] 
    41 He who invents adages for others to peruse 
    42 takes along rowboat when going on cruise. 
    43 [http://forums.3ivx.com/index.php?showuser=16165 cheap Cialis and Cialis] 
    44 [http://us.cyworld.com/buyviagraorderviagra order viagra online] 
    45 http://www.aboutus.org/BuyCialis.cc 
    46 http://buyviagraonline.gather.com/ 
    47 [http://us.cyworld.com/buylevitra1 levitra] 
    48 [http://www.folkd.com/user/tramadolonline tramadol hcl] 
    49 KjqqwX1 
    50 http://bink.nu/members/buy_2D00_levitra_2D00_online_2D00_cheap_2D00_levita.aspx 
    51 http://buytramadol.gather.com/ 
    52 [http://www.gomedia.us/forum/member.php?u=1621 fioricet orders] 
    53 [http://www.cittaeducativa.roma.it/moodle/user/view.php?id=2744&compra-viagra-cialis viagra di marca e cialis] 
    54 http://fioricetonline.gather.com/ 
    55 http://blogs.devleap.com/members/Compra_2D00_Viagra.aspx 
    56 Revenge is a form of nostalgia. 
    57 [http://forum.desktopreview.com/member.php?u=145579 cheap Cialis and Cialis] 
    58 [http://us.cyworld.com/buyviagraorderviagra cheap viagra] 
    59 http://www.folkd.com/user/buycialisonline 
    60 http://buycialis.cc/en/item/viagra.html 
    61 [http://buycialis.cc/en/item/levitra.html levitra] 
    62 [http://forums.3ivx.com/index.php?showuser=16164 how to buy tramadol] 
    63 nn0P/4j 
    64 http://buylevitra.gather.com/ 
    65 http://www.folkd.com/user/tramadolonline 
    66 [http://community.icontact.com/users/buyfioricet fioricet] 
    67 [http://labreti.ing.uniroma1.it/moodle/user/view.php?id=235&course=1#viagra comprare viagra dall'Italia] 
    68 http://forums.3ivx.com/index.php?showuser=16168 
    69 http://www.popolodellarete.it/member.php?u=21746 
    70 A Fortran compiler is the hobgoblin of little minis. 
    71 [http://www.mania.com/buycialis/blog.html buy generic cialis] 
    72 [http://www.folkd.com/user/buyviagra1 buy brand viagra] 
    73 http://www.jayde.com/15220257-buycialis.html 
    74 http://buyviagraonline.gather.com/ 
    75 [http://subscene.com/members/Buy_2D00_levitra_2D00_online.aspx generic levitra] 
    76 [http://forums.plexapp.com/index.php?showuser=8414 tramadol generic] 
    77 goZxFIg 
    78 http://buycialis.cc/en/item/levitra.html 
    79 http://www.xomreviews.com/relievepain.org 
    80 [http://forums.3ivx.com/index.php?showuser=16168 fioricet consultation] 
    81 [http://www.svibrescia.it/jforum/user/profile/129.page viagra on line] 
    82 http://headachetreatment.net 
    83 http://subscene.com/members/Compra-Viagra-e-Cialis-Online_2E00_.aspx 
     43  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0] 
     44 
     45This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]). 
     46 
     47Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading `?` character: 
     48{{{ 
     49[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner] 
     50}}} 
     51 
     52Which is displayed as: 
     53  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner] 
     54 
     55=== Using the `[[TicketQuery]]` Macro === 
     56 
     57The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting. 
     58 
     59Example: 
     60{{{ 
     61[[TicketQuery(version=0.6|0.7&resolution=duplicate)]] 
     62}}} 
     63 
     64This is displayed as: 
     65  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]] 
     66 
     67Just 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 
     69A more compact representation without the ticket summaries is also available: 
     70{{{ 
     71[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]] 
     72}}} 
     73 
     74This is displayed as: 
     75  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]] 
     76 
     77Finally, if you wish to receive only the number of defects that match the query, use the ``count`` parameter. 
     78 
     79{{{ 
     80[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]] 
     81}}} 
     82 
     83This is displayed as: 
     84  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]] 
     85 
     86=== Customizing the ''table'' format === 
     87You 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 
     89{{{ 
     90[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]] 
     91}}} 
     92 
     93This is displayed as: 
     94[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]] 
     95 
     96==== Full rows ==== 
     97In ''table'' format you can also have full rows by using ''rows=<field>'' like below: 
     98 
     99{{{ 
     100[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]] 
     101}}} 
     102 
     103This is displayed as: 
     104[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]] 
     105 
     106 
     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 literal `&` or `|` in a value, escape the character with a backslash (`\`). 
     110 
     111The available operators are: 
     112|| '''`=`''' || the field content exactly matches one of the values || 
     113|| '''`~=`''' || the field content contains one or more of the values || 
     114|| '''`^=`''' || the field content starts with one of the values || 
     115|| '''`$=`''' || the field content ends with one of the values || 
     116 
     117All of these operators can also be negated: 
     118|| '''`!=`''' || the field content matches none of the values || 
     119|| '''`!~=`''' || the field content does not contain any of the values || 
     120|| '''`!^=`''' || the field content does not start with any of the values || 
     121|| '''`!$=`''' || the field content does not end with any of the values || 
     122 
     123The 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.  
     124|| '''`created=2007-01-01..2008-01-01`''' || query tickets created in 2007 || 
     125|| '''`created=lastmonth..thismonth`''' || query tickets created during the previous month || 
     126|| '''`modified=1weekago..`''' || query tickets that have been modified in the last week || 
     127|| '''`modified=..30daysago`''' || query tickets that have been inactive for the last 30 days || 
     128 
     129---- 
     130See also: TracTickets, TracReports, TracGuide