wiki:TracQuery

Trac Ticket Queries

In addition to reports, Trac provides support for custom ticket queries, used to display lists of tickets meeting a specified set of criteria.

To configure and execute a custom query, switch to the View Tickets module from the navigation bar, and select the Custom Query link.

Filters

When you first go to the query page the default filter will display tickets relevant to you:

  • If logged in then all open tickets it will display open tickets assigned to you.
  • 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.
  • If not logged and no name/email defined in the preferences then all open issues are displayed.

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 of the criteria.

You 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.

Once you've edited your filters click the Update button to refresh your results.

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.

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 it no longer matches the query criteria the text will also be greyed. Lastly, if a new ticket matching the query criteria has been created, it will be shown in bold.

The query results can be refreshed and cleared of these status indicators by clicking the Update button again.

Saving Queries

Trac 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. You can also save references to queries in Wiki content, as described below.

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.

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.

You 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.

[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

Which is displayed as:

Active tickets against 1.0

This uses a very simple query language to specify the criteria (see Query Language).

Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading ? character:

[query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

Which is displayed as:

Assigned tickets by owner

Using the [[TicketQuery]] Macro

The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:

[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

This is displayed as:

#16
Create proper website
#17
Add mouse support
#22
Turn next_xp option on permanently
#37
Split up externs.h into other headers, to allow less recompiling
#74
Add reference counting to the quarks package
#75
Panic saves shouldn't overwrite normal savefiles
#109
Remove unused ports
#110
Slim down number of ports further
#113
Build/Package win console mode angband along with windows binaries
#178
Lanterns of everburning should not be fuellable or useable as fuel
#237
Windows Angband reacts to clicks while in the background
#267
message displays wrong total count after purchasing items that you already have
#306
run isn't working
#439
Armour with negative to-hit gets classed as "magical"
#493
Windows port doesn't save when computer shut down
#523
Import FA's get_item() and get_spell() menu-ified functions
#530
Allow reviewing the contents of the home from the knowledge screens.
#577
Debug mode isn't friendly in the slightest
#582
Traps are boring
#606
Macro's still use normal keyset when game is set for roguelike keys
#632
Detect Enchantment should be more consistent
#650
Infinite Scroll of Rune of Protection
#660
Allow New Game/Load Game without Quitting
#785
Various mushrooms have 0 value and squelch by default
#815
Lose turn when unable to attack
#846
Numbers in item description neglect item's own pval
#863
Allow home inventory to be accessible from knowledge menu
#881
Inpsect needs a more prompt
#911
Monster list needs a go-through
#967
Some artifacts not placed into history when found/ID'd
#971
inconsitency in monster info and rod information
#977
Garbage in message recall window when dropping items in home
#1035
Display relative speed
#1044
"this can never happen!" happens whenever a rod recharges.
#1080
Add min/max depths for ego types
#1108
Add no_selling option
#1126
Enchant scrolls do not remember the selected item when repeating with 'n'
#1147
don't reduce energy on load
#1164
Improve the item list
#1200
Trap suggestions
#1271
Fix or remove variance in gold drops
#1272
Need -lSDL on new(ish) Linux
#1284
Move to C99 types
#1289
Remove cheat options, move them to wizard mode
#1294
Version 3.2 crashes immediately upon startup (Intel Mac, OS X 10.5.8)
#1295
Allow access to birth options at the final stage of character creation
#1323
Monsters should have unique names
#1344
cannot handle window more than 256 chars wide
#1372
gruesome bug leaps and then segfault at C-x; reproducible
#1374
Loading window preferences doesn't work
#1400
Restore Item "mends" =Mouse, =Dog
#1405
Mutiple Pval oddness
#1416
Staff of Detect Invisible not showing invisible monster
#1418
Pressing return while using roguelike keys tunnels downward.
#1420
Detect Invisible does not always detect invisible monsters
#1423
Accents do not always display properly
#1426
Crash when down arrow is pressed
#1496
Improve running
#1532
Update spoilers
#1578
Ensure that effect values are >0 in project_m
#1649
mon_inc_timed: Assertion `timer > 0' failed.
#1685
Improper capitalization in some messages.
#1724
SDL port crash on exit with stack trashing
#1730
Crash in SDL port upon exit
#1762
Graphics gone all squiffy
#1769
Potion mimics shatter twice when destroyed
#1807
Squelched Items appear in message line on walkover
#1808
Monster recall subterm does not refresh on level change

Just like the query: wiki links, the parameter of this macro expects a query string formatted according to the rules of the simple ticket query language. This also allows displaying the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

No results

A more compact representation without the ticket summaries is also available:

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#16, #17, #22, #37, #74, #75, #109, #110, #113, #178, #237, #267, #306, #439, #493, #523, #530, #577, #582, #606, #632, #650, #660, #785, #815, #846, #863, #881, #911, #967, #971, #977, #1035, #1044, #1080, #1108, #1126, #1147, #1164, #1200, #1271, #1272, #1284, #1289, #1294, #1295, #1323, #1344, #1372, #1374, #1400, #1405, #1416, #1418, #1420, #1423, #1426, #1496, #1532, #1578, #1649, #1685, #1724, #1730, #1762, #1769, #1807, #1808

Finally, if you wish to receive only the number of defects that match the query, use the count parameter.

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:

68

Customizing the table format

You 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:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 1489)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1808 duplicate Monster recall subterm does not refresh on level change myshkin
#1807 duplicate Squelched Items appear in message line on walkover myshkin
#1806 fixed (in master) No message when monster is hurt by chaos strike PowerWyrm
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can also have full rows by using rows=<field> like below:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]

This is displayed as:

Results (1 - 3 of 1489)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1808 duplicate Monster recall subterm does not refresh on level change myshkin
Description

Reported by Ingwe Ingweron on oook for ?DeepDescent.

#1807 duplicate Squelched Items appear in message line on walkover myshkin
Description

Reported by Ingwe Ingeron on oook.

#1806 fixed (in master) No message when monster is hurt by chaos strike PowerWyrm
Description

The message is masked by the polymorph effect. This is ok when polymorphing succeeds ("The monster changes." is explicit). But if the polymorph fails, you get "The monster is unaffected!", even if said monster takes 300 damage from the spell. In this case, the "pain" message should probably take priority over the effect message.

This is probably the case for all effects. Being "unaffected" should probably be displayed only if the damage is zero or reduced by resistance. In case of full damage (like chaos strike vs polymorphing), the pain message should be displayed.

1 2 3 4 5 6 7 8 9 10 11

Query Language

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 (\).

The available operators are:

= the field content exactly matches one of the values
~= the field content contains one or more of the values
^= the field content starts with one of the values
$= the field content ends with one of the values

All of these operators can also be negated:

!= the field content matches none of the values
!~= the field content does not contain any of the values
!^= the field content does not start with any of the values
!$= the field content does not end with any of the values

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 left out to avoid having to quote the query string.

created=2007-01-01..2008-01-01 query tickets created in 2007
created=lastmonth..thismonth query tickets created during the previous month
modified=1weekago.. query tickets that have been modified in the last week
modified=..30daysago query tickets that have been inactive for the last 30 days

See also: TracTickets, TracReports, TracGuide

Last modified 11 months ago Last modified on 09/11/13 03:23:08