wiki:TracQuery

Version 1 (modified by trac, 8 years ago) (diff)

--

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.

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:

No results

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.

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

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

This is displayed as:

No results

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:

0

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 68)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#73 fixed Settings in lSwitcher's properties notebook are always saved? Alfredo Fernández Díaz
#72 fixed lSwitcher widget traps when accessing grouped item menu Gregg Young Gregg Young
#71 fixed lSwitcher widget causes XCenter to hang on shut down if a switch from a full screen session has been done Gregg Young Gregg Young
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 68)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#73 fixed Settings in lSwitcher's properties notebook are always saved? Alfredo Fernández Díaz
Description

While translating the manual, I just installed the latest 2.91rc1 from the dev list on a fresh AOS 5 to test the Spanish resources in a live environment, and try to keep UI and docs well in synch.

I quickly found out that both buttons 'Save' and 'Cancel' at the bottom of the Properties notebook do nothing and the same thing -- I tried a few settings (filters, and display properties of the tb, pmwp hints) and they all seem to be saved right away, which in turn renders both buttons useless.

#72 fixed lSwitcher widget traps when accessing grouped item menu Gregg Young Gregg Young
Description

This is new with XWP 1.0.12. It happens after you open a second group member with Xcenter open. Generally after you reopen Xcenter it is fine until you open another group member. Sometimes you get a very small menu (clipped or no text) instead of the trap.

ArcaOS Desktop trap message -- Date: 2018-12-01, Time: 16:22:39
-----------------------------------------------------------

An internal error occurred in ArcaOS Desktop (XFLDR.DLL).
Please send a bug report to xworkplace-user@netlabs.org
so that this error may be fixed for future ArcaOS Desktop versions.
Please supply this file (?:\xwptrap.log) with your e-mail
and describe as exactly as possible the conditions under which
the error occurred.

Running XFLDR.DLL version: 1.0.12 built Nov 24 2018
Running OS/2 version: 20.45.0 (WSeB kernel)

excHandlerLoud:
    Exception type: C0000005
    Address:        1C4846FC
    Params:         00000001  00E50000  
XCPT_ACCESS_VIOLATION: XCPT_READ_ACCESS -- Invalid read access from 0x0053:00E50000.
Explanation: An attempt was made to access a memory object which does
             not belong to the current process. Most probable causes
             for this are that an invalid pointer was used, there was
             confusion with administering memory or error conditions 
             were not properly checked for.

Process information:
    Process ID:      0x2D
    Process module:  0x493 (J:\OS2\PMSHELL.EXE)
    Trapping module: 0x1D40 (J:\SYS\APPS\XWPS\PLUGINS\XCENTER\LSWIDGET.DLL)
    Object: 1

Trapping thread information:
    Thread ID:       0x8 (8)
    Thread slot ID:  0x77 (119)
    Priority:        0x31F

Exception handler:
    Set by:          D:\prj\xwp\new\xworkplace-1-0\src\xcenter\ctr_engine.c::ctrp_fntXCenter()

Thread identification:
    TID 0x8 (8)  (XCenter)
The following threads could be identified:
    PMSHELL Workplace thread ID: 0x1
    NotifySentinel: ID 0xB (11)
    RefreshFindFolder: ID 0xC (12)
    RefreshNotificationPump: ID 0xD (13)
    NotifyServer: ID 0xE (14)
    Party: ID 0xF (15)
    Worker: ID 0x10 (16)
    Bush: ID 0x11 (17)
    Wimp: ID 0x12 (18)
    File: ID 0x13 (19)
    LazyIcons: ID 0x1E (30)
    XCenter: ID 0x8 (8)
    PulseWidgetCollect: ID 0x20 (32)

Global lock semaphore is currently not owned.

Registers:
    DS  = 00000053  
    ES  = 00000053  
    FS  = 0000150B  
    GS  = 00000000  
    EAX = 00000000  not an address
    EBX = 00018005  valid, flags: read execute 
    ECX = FFFFFFFF  invalid address
    EDX = 1B79FFFF  valid, flags: read write committed shared 
    ESI = 00E76330  valid, flags: read write committed 
    EDI = 00E50000  valid, flags: read write 

Instruction pointer (where exception occurred):
    CS:EIP = 005B:1C4846FC  valid, flags: read execute committed shared 
    EFLAGS = 00210246

Stack:
    Base:         00E30000
    Limit:        00E77000
    SS:ESP = 0053:00E75B28  valid, flags: read write committed 
    EBP    =      00E75FDE  valid, flags: read write committed 

Stack frames:
              Address   Module   seg:ofs
    CS:EIP  : 1C4846FC  LSWIDGET 02:000046FC
                                 between ButtonWndProc + 0x1AD 
                                     and TskBarFrameWndProc - 0xE5C 

    00E75FDE: FFFF00E7  unknown  Error: DosQueryModFromEIP returned 487

    pulStackWord >= (PULONG)ptib->tib_pstacklimit

#71 fixed lSwitcher widget causes XCenter to hang on shut down if a switch from a full screen session has been done Gregg Young Gregg Young
Description

Ctrl+Esc causes is as does Alt/Ctrl?+Tab. Opening and closing XCenter fixes it even if the full screen session is still open. The shut down dialog disappears in some cases but if it doesn't and you skip XCenter shut down completes. After the failure Shutdown and restart desktop are greyed out. However if you restart the desktop from CADH you can then shut down.

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