Version 7 (modified by trac, 4 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.

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:

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. This also allows displaying the link and description of a single ticket:

[[TicketQuery(id=123)]]

This is displayed as:

#123
Typo in the model_api/#field-types

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#27772 needsinfo Multiple Database without Default nobody Sammie S. Taunton
#27771 wontfix Problem with unicode literals and EMAIL_PORT nobody Michal Čihař
#27770 duplicate {% include %} with the template instance is broken under django 1.11 nobody Mikhail Podgurskiy
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 25804)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#27772 needsinfo Multiple Database without Default nobody Sammie S. Taunton
Description

Following the example on https://docs.djangoproject.com/en/1.10/topics/db/multi-db/

I created 2 databases, setup the routers in the example, and tested

Data being selected appears to be working however when trying to insert OR update I'm receiving the following error:

Performing system checks...

System check identified no issues (0 silenced).
January 24, 2017 - 21:33:54
Django version 1.10.5, using settings 'application.settings'
Starting development server at http://10.4.1.1:80/
Quit the server with CONTROL-C.
Internal Server Error: /en/employee/edit
Traceback (most recent call last):
  File "/usr/local/python/lib/python3.6/site-packages/django/core/handlers/exception.py", line 39, in inner
    response = get_response(request)
  File "/usr/local/python/lib/python3.6/site-packages/django/core/handlers/base.py", line 187, in _get_response
    response = self.process_exception_by_middleware(e, request)
  File "/usr/local/python/lib/python3.6/site-packages/django/core/handlers/base.py", line 185, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/usr/local/python/lib/python3.6/site-packages/django/contrib/auth/decorators.py", line 23, in _wrapped_view
    return view_func(request, *args, **kwargs)
  File "/vhosts/admin-install/login/security/gacl.py", line 27, in _wrapper
    return view_func(request, *args, **kwargs)
  File "/vhosts/admin-install/employee/views.py", line 112, in edit
    result2 = ServiceEdit(request).edit(form.cleaned_data)
  File "/usr/local/python/lib/python3.6/contextlib.py", line 52, in inner
    with self._recreate_cm():
  File "/usr/local/python/lib/python3.6/site-packages/django/db/transaction.py", line 158, in __enter__
    if not connection.get_autocommit():
  File "/usr/local/python/lib/python3.6/site-packages/django/db/backends/base/base.py", line 365, in get_autocommit
    self.ensure_connection()
  File "/usr/local/python/lib/python3.6/site-packages/django/db/backends/dummy/base.py", line 21, in complain
    raise ImproperlyConfigured("settings.DATABASES is improperly configured. "
django.core.exceptions.ImproperlyConfigured: settings.DATABASES is improperly configured. Please supply the ENGINE value. Check settings documentation for more details.
[24/Jan/2017 21:33:58] "POST /en/employee/edit HTTP/1.1" 500 19406

This is caused by the empty 'default': {} database configuration. I copied the primary settings into the default area and now things are working. However, I'd prefer to not be forced into using the default setting, which from the documentation in a multi-db setup the default is not required to be filled out, only the key needs to be there (which is fine).

As an additional test I added print() statements to the DB Router definitions for db_for_read, db_for_write, allow_relation, and allow_migrate. This would allow me to see when the page is reloaded / submitted if the query is even passing through the router. Reads were in fact going to the router as expected, however insert/updates were not. No print statement, only the error message.

Read Test in DB Router:

Performing system checks...

System check identified no issues (0 silenced).
January 24, 2017 - 21:46:01
Django version 1.10.5, using settings 'application.settings'
Starting development server at http://10.4.1.1:80/
Quit the server with CONTROL-C.
TEST READ MESSAGE
[24/Jan/2017 21:46:03] "GET /en/employee/edit HTTP/1.1" 200 74622

So based on this, I can only assume the routing is not happening properly someplace.

I'm willing to try what is needed to help resolve this.

#27771 wontfix Problem with unicode literals and EMAIL_PORT nobody Michal Čihař
Description

When your settings.py looks like:

from __future__ import unicode_literals
EMAIL_HOST= 'localhost'
EMAIL_PORT = '587'

You end up with error when sending mail:

File "/opt/weblate/.local/lib/python2.7/site-packages/django/core/mail/backends/smtp.py" in open
  58.             self.connection = connection_class(self.host, self.port, **connection_params)

File "/usr/lib/python2.7/smtplib.py" in __init__
  256.             (code, msg) = self.connect(host, port)

File "/usr/lib/python2.7/smtplib.py" in connect
  316.         self.sock = self._get_socket(host, port, self.timeout)

File "/usr/lib/python2.7/smtplib.py" in _get_socket
  291.         return socket.create_connection((host, port), timeout)

File "/usr/lib/python2.7/socket.py" in create_connection
  553.     for res in getaddrinfo(host, port, 0, SOCK_STREAM):

Exception Type: error at /accounts/register/
Exception Value: getaddrinfo() argument 2 must be integer or string

This is caused by fact that that getaddrinfo happily accepts int or string, but not unicode literals as port (it doesn't have problem with unicode literals as hostname though):

>>> from __future__ import unicode_literals
>>> import socket
>>> socket.getaddrinfo('localhost', '567', 0, socket.SOCK_STREAM)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
socket.error: getaddrinfo() argument 2 must be integer or string

I think Django should prevent this configuration error, or at least properly tell where the problem is.

Originally reported at https://github.com/WeblateOrg/weblate/issues/1330

#27770 duplicate {% include %} with the template instance is broken under django 1.11 nobody Mikhail Podgurskiy
Description

As stated in the django docs, the {% include %} tag could accept a template instance to render - https://docs.djangoproject.com/en/1.10/ref/templates/builtins/#include

include

Loads a template and renders it with the current context. This is a way of “including” other templates within a template.

The variable may also be any object with a render() method that accepts a context. This allows you to reference a compiled Template in your context.

This leads to RequestContext from the main template been passed to the included template.render method and this became prohibited within https://code.djangoproject.com/ticket/27258 changeset

TypeError at ...
context must be a dict rather than RequestContext.
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

Back to Top