Edgewall Software

This page documents the 0.12 release. Documentation for other releases can be found here.

Trac Ticket Queries

Languages:

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:

#181
Wiki preview injects new lines
#204
request for colour legend (or something similar) for ticket groups in reports
#226
Ticket Dependencies
#239
Link to diff of specifik wiki change instead of the page itself
#351
All ticket modifications should be tracked in timeline
#413
Installing on Windows, drive other than C:
#450
Diffviewer should try to convert the text into utf-8.
#475
merging of similar tickets
#519
Python process sometimes hangs on Windows Server 2003
#529
IE 5-6 over HTTPS broken downloads

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:

#123
No SQL error display

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

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

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

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:

10

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:

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13173 wontfix Abort previous search when starting new search anonymous
Description

After clicking the Search button I sometimes notice I typed the search term wrong or forgot to change the search checkboxes. I fix it and click Search again. But then (because Trac search is a bit slow sometimes) the first search result arrives and is displayed, and my changes to the search term or checkboxes of my second search gets lost.

Is there a way to avoid losing the changed search parameters? Or just abort the first search when the second search is started? I don't know if this is technically possible.

Thanks!

#13172 cantfix Polish locale file (pl.js) missing in 1.2.3 wheel anonymous
Description

Dear trac devs,

polish locale js file (pl.js) is not present in the Trac-1.2.3-py2-none-any.whl file:

wget "https://files.pythonhosted.org/packages/41/66/6adf72f889af8a16f8e32246c9db9d666826a6a7d267fd57fefd6095d238/Trac-1.2.3-py2-none-any.whl"

unzip -l Trac-1.2.3-py2-none-any.whl | grep /pl
   127813  2018-07-29 18:42   trac/locale/pl/LC_MESSAGES/messages.mo
    72865  2018-07-29 18:42   trac/locale/pl/LC_MESSAGES/tracini.mo

unzip -l Trac-1.2.3-py2-none-any.whl | grep pl.js | wc -l
0

is there any reason to not to have this file included in the whl file?

#13168 fixed Query._get_constraints() should not modify a list in req.args Jun Omae Jun Omae
Description

I sometimes encounter IndexErrors from Query._get_constraints() on our production environment with private plugin which calls Query._get_constraints().

ERROR: Internal Server Error: <RequestWithSession "POST '/query'">, referrer 'https://example.org/query'
Traceback (most recent call last):
  File "/venv/lib/python2.7/site-packages/trac/web/main.py", line 554, in _dispatch_request
    dispatcher.dispatch(req)
  File "/venv/lib/python2.7/site-packages/trac/web/main.py", line 257, in dispatch
    self._post_process_request(req, *resp)
  File "/venv/lib/python2.7/site-packages/trac/web/main.py", line 388, in _post_process_request
    resp = f.post_process_request(req, *resp)
  File "/vol/releases/20190322024230/share/plugins/XxxPlugin.egg/xxx/project/ticket/custom_field.py", line 626, in post_process_request
    if not mod._get_constraints(req) and 'order' not in req.args:
  File "/venv/lib/python2.7/site-packages/trac/ticket/query.py", line 1066, in _get_constraints
    del vals[idx]
IndexError: list assignment index out of range

Investigating the issue, it is caused by that Query._get_constraints() modifies a list in req.args and is called twice when a condition is removed.

I don't consider the method should modify a list in req.args.

[9f904f1df/jomae.git]:

  • trac/ticket/query.py

    diff --git a/trac/ticket/query.py b/trac/ticket/query.py
    index 3fbe171f1..80ca3c054 100644
    a b class QueryModule(Component):  
    10441044            # requested for clients without JavaScript
    10451045            add_num = None
    10461046            constraints = {}
    1047             for k, vals in req.args.iteritems():
     1047            for k in req.args:
    10481048                match = self.add_re.match(k)
    10491049                if match:
    10501050                    add_num = match.group(1)
    class QueryModule(Component):  
    10561056                clause_num = int(match.group('clause'))
    10571057                if field not in fields:
    10581058                    continue
    1059                 if not isinstance(vals, (list, tuple)):
    1060                     vals = [vals]
     1059                # use list() to avoid modification of a list in req.args
     1060                vals = list(req.args.getlist(k))
    10611061                if vals:
    10621062                    mode = req.args.get(k + '_mode')
    10631063                    if mode:
  • trac/ticket/tests/query.py

    diff --git a/trac/ticket/tests/query.py b/trac/ticket/tests/query.py
    index cb2d0fc6e..e8cce442c 100644
    a b ORDER BY COALESCE(c.%(ticket)s,'')='',c.%(ticket)s,t.id""" % quoted)  
    11081108        prop = req.chrome['script_data']['properties']['milestone']
    11091109        self.assertEqual({'label': 'Milestone', 'type': 'text'}, prop)
    11101110
     1111    def test_get_constraints_keep_req_args(self):
     1112        arg_list = (('0_type', 'defect'), ('0_type', 'task'),
     1113                    ('0_type', 'enhancement'), ('rm_filter_0_type_1', '-'),
     1114                    ('1_type', 'task'))
     1115        req = MockRequest(self.env, method='POST', path_info='/query',
     1116                          arg_list=arg_list)
     1117        orig_args = arg_list_to_args(arg_list)
     1118        mod = QueryModule(self.env)
     1119        self.assertTrue(mod.match_request(req))
     1120        template, data, content_type = mod.process_request(req)
     1121        self.assertEqual([{'type': ['defect', 'enhancement']},
     1122                          {'type': ['task']}],
     1123                         data['query'].constraints)
     1124        self.assertEqual(orig_args, req.args)
     1125
    11111126
    11121127class QueryLinksTestCase(unittest.TestCase):
    11131128
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 5 years ago Last modified on Nov 3, 2014, 3:40:46 AM
Note: See TracWiki for help on using the wiki.