| Version 2 (modified by , 11 years ago) ( diff ) |
|---|
Trac Ticket Queries
Table of Contents
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.
Navigating Tickets
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.
Using TracLinks
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:
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:
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:
- #278
- User-defined galleries
- #292
- Enable "favoriting" of media
- #334
- Display number of views a media object has had
- #391
- Presentation and/or document media type support?
- #395
- Make license options customizable and drop non-FaiF options by default
- #408
- Localized dates and times
- #446
- Make it easier to download the published audio file
- #449
- Add download link to audio media type
- #455
- Tests fail because of audio metadata table
- #493
- Use OpenWebFonts
- #504
- Internationalization sets the language used in the comment notification email template
- #525
- allow to register to let comment on my cat pics
- #547
- Need better PuSH mechanism
- #559
- Collections can only be found from a file's page, no list to be found
- #609
- Sharing of private collections
- #631
- When name of upload conflicts with existing media, mg uses the id number, but does not check whether an exisiting item is named that.
- #656
- Need a list of "Tests for Humans"
- #717
- Video thumbnails are not created
- #726
- Allow to embed GNU Mediagoblin player in a web page
- #769
- I tried send comment and got -> Server Error
- #784
- Visual indication of media type on gallery page thumbnails
- #825
- Problem with one special jpg
- #834
- File upload size limited by available system memory
- #892
- Data liberation
- #929
- Thumbnails in the collection view are missing file title
- #937
- transifex
- #995
- Uploading images by drag&drop
- #1038
- Deleting media causes feed API issue
- #1074
- Upload audio to GNU MediaGoblin via the API
- #1101
- Typo in mediagoblin.pot
- #5020
- Errors in translations
- #5035
- gi warnings
- #5306
- Hard-coded absolute URL path in frontpage_welcome.html
- #5312
- Install Scripts Shebang on Freebsd
- #5335
- Particular PDF not uploading
- #5336
- Bug in media types extension parsing
- #5337
- Number of views does not exist for media
- #5348
- PDF processing fails on non-ASCII characters in extract_pdf_info
- #5358
- Tests failing in current master
- #5362
- Audio submission test fails with
- #5384
- Compiling error involving babel an localedata
- #5453
- migration will fail when disable a previously enabled plugin
- #5461
- Never ends processing
- #5479
- Adding the Peer Production License as one option more when submitting content
- #5497
- 0.9.0 pdf fails: No plugins using two-step checking found
- #5498
- misleading messages uploading PDFs: No plugins using two-step checking found (0.9.0)
- #5499
- Show log messages for failed uploads in Media processing panel
- #5557
- ValueError when trying to submit media
- #5574
- Improve docker builds for deployment and/or development
- #5591
- Avoiding up-scaling low-res videos
- #5606
- Hook up lightbox effect for images
- #5622
- Doc update - pyexiv2
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
- We need a margin between the media image and the sidebar
A more compact representation without the ticket summaries is also available:
[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
This is displayed as:
#278, #292, #334, #391, #395, #408, #446, #449, #455, #493, #504, #525, #547, #559, #609, #631, #656, #717, #726, #769, #784, #825, #834, #892, #929, #937, #995, #1038, #1074, #1101, #5020, #5035, #5306, #5312, #5335, #5336, #5337, #5348, #5358, #5362, #5384, #5453, #5461, #5479, #5497, #5498, #5499, #5557, #5574, #5591, #5606, #5622
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:
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 1173)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #5631 | invalid | this is a test | ||
| #5627 | fixed | Generalise keyboard navigation | ||
| #5626 | fixed | Upgrade issue from 0.10 to 0.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 1173)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #5631 | invalid | this is a test | ||
| #5627 | fixed | Generalise keyboard navigation | ||
| Description |
The media display pages allow to use the left and right arrows to navigate between media. The patch at https://scm.narf.ssji.net/git/mediagoblin/patch/?id=1ba9ee46e56e6c77aab964c19de07c6d34d933ee generalises this for other pages, such as galleries. This commit is part of my work on #5619, which is still a WIP. However, this particular change should be good to go. |
|||
| #5626 | fixed | Upgrade issue from 0.10 to 0.11 | ||
| Description |
following the upgrade guide (and the installation guide just in case), I've encounter the following issue during upgrade: 1) after launching this command: ./bootstrap.sh && VIRTUALENV_FLAGS='--system-site-packages' ./configure && make it fails during setup saying idna3.2 is installed (as one package require >2 and it picks the last available) but a later one require < 3 (this could be removed because python2 support has been dropped). workaround was: ./bin/pip uninstall idna ./bin/pip install idna==2.10 and relaunch the last step: ./bin/python setup.py develop --upgrade and continue the rest of the upgrade process: make 2) on the last upgrade process we have to upgrade the db: ./bin/gmg dbupdate this fails because jsonschema.compat is not found workaround: commenting the import from the following file mediagoblin/tools/metadata.py and now the gmg dbupdate works. YMMV but that's what happend for me on buster 10.10 on 5th july 2021. (date can be important due to external nodejs dependency) - and it is only reported now as the trac seemed to have been broken for a while (on my side at least). thanks again for this new release, works quite well so far! |
|||
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
