wiki:TicketQuery

TicketQuery Wiki Macro

The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. The query language used by the [[TicketQuery]] macro is described in the TracQuery page.

Usage

[[TicketQuery]]

Wiki macro listing tickets that match certain criteria.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value".

If the key is the name of a field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage. Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character. Commas (,) can be included in field values by escaping them with a backslash (\).

Groups of field constraints to be OR-ed together can be separated by a literal or argument.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The format parameter determines how the list of tickets is presented:

  • list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed
  • rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
  • table -- a view similar to the custom query view (but without the controls)
  • progress -- a view similar to the milestone progress bars

The max parameter can be used to limit the number of tickets shown (defaults to 0, i.e. no maximum).

The order parameter sets the field used for ordering tickets (defaults to id).

The desc parameter indicates whether the order of the tickets should be reversed (defaults to false).

The group parameter sets the field used for grouping tickets (defaults to not being set).

The groupdesc parameter indicates whether the natural display order of the groups should be reversed (defaults to false).

The verbose parameter can be set to a true value in order to get the description for the listed tickets. For table format only. deprecated in favor of the rows parameter

The rows parameter can be used to specify which field(s) should be viewed as a row, e.g. rows=description|summary

The col parameter can be used to specify which fields should be viewed as columns. For table format only.

For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format. Also, using "&" as a field separator still works (except for order) but is deprecated.

Examples

Example Result Macro
Number of Triage tickets: 0 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 62 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 0 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 26 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 8 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 11 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 57 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 817 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 0 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 983 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 0 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 0 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 0 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 0 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 0 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 0 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 0 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 0 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #202, #978, #791 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:

[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]

Ticket Owner Reporter
#1 Jari Häkkinen Jari Häkkinen
Summary Checking of write permissions to files in FileIO does not work

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123
document SNR::score weighted version

Format: compact

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

This is displayed as:

No results

Format: count

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

This is displayed as:

0

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

Format: table

You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed by placing pipes (|) between the columns:

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

This is displayed as:

Results (1 - 3 of 919)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#982 fixed Scheduler::throw_if_error does not close member threads Peter Peter
#981 fixed race conditions in the Scheduler::JobHandler Peter Peter
#980 fixed Scheduler out of scope after call to interrupt() may cause abort Peter Peter
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can specify full rows using rows=<field>:

[[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 919)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#982 fixed Scheduler::throw_if_error does not close member threads Peter Peter
Description

If throw_if_error is detecting an error so it throws and was not called from ::wait, the job_handler_ is most likely still running and the exception might very well be thrown so far out that the Scheduler is out of scope to cause an abort.

Solution: throw_if_error has to clean up and wait for threads before the exception is thrown.

#981 fixed race conditions in the Scheduler::JobHandler Peter Peter
Description

In JobHandler::post_process an error is pushed to the error Queue. A few moments later in while loop in operator() we check if the queue is empty, but since this queue is shared with the Scheduler object where it's popped occasionally, there is a race condition that might cause strange unexpected behaviour.

The solution seems to be to move as much as possible of the action to post_process and introduce a member variable telling the while loop to break. The latter will break ABI and cannot be added in a stable branch.

#980 fixed Scheduler out of scope after call to interrupt() may cause abort Peter Peter
Description

The documentation says that

In the current implementation all submitted jobs have to be completed
before the Scheduler goes out of scope, which can be accomplished by
calling wait() or interrupt().

This is misleading because if I call interrupt() and then let the Scheduler go out of scope, I get a

terminate called without an active exception
Aborted (core dumped)

The reason is that the interrupt simply sends a message to the job_handler_ thread to wrap up things and finish, but interrupt() is not waiting for that so it returns and the Scheduler may very well go out of scope. The Scheduler destructor calls the destructor of the std::thread object, which is not okay if it's still running.

Documentation or behaviour needs to change and it the documented behaviour is quite what I'd expect, so I suggest we change the behaviour, which should hopefully be trivial and possible without breaking the ABI.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 3 years ago Last modified on Feb 4, 2019, 2:49:51 PM