wiki:TracQuery
Last modified 11 months ago Last modified on 03/14/11 17:44:22

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

1 2
Ticket Resolution Summary Owner Reporter
#4 fixed 15 tests failures and 1 error after running test.rb deveiant deveiant
#3 fixed WordNet::Synset::Pointer doesn't handle new compound pointer types deveiant deveiant
#2 fixed Lexicon requires writable data files/directory deveiant deveiant
1 2

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

1 2
Ticket Resolution Summary Owner Reporter
#4 fixed 15 tests failures and 1 error after running test.rb deveiant deveiant

Reported by deveiant, 5 years ago.

Description

Ubuntu 7.04
ruby 1.8.5 (2006-08-25) [i486-linux]
WordNet?-3.0


After much heartache I was able to successfully install Ruby WordNet? but some of the tests fail at the end when running 'ruby test.rb'. I am able to load up the library from Linguistics as well as separately using require 'wordnet', but all commands bring back nil values. The pre-packaged test.rb does not let me run - it returns:

./tests/wntestcase.rb:57:in `require': no such file to load -- test/unit/mock (LoadError)
        from ./tests/wntestcase.rb:57
        from test.rb:15:in `require'
        from test.rb:15
        from ./utils.rb:665:in `verboseOff'
        from test.rb:14

I tried installing the Test::Unit::Mock library but didn't get very far. I checked out the latest source code from SVN using:

svn checkout svn://deveiate.org/Ruby-WordNet/trunk

I was able to run the tests without error using this revision. After successfully converting the WordNet? data files - I ran ruby test.rb and received the following errors:

0 patterns given on the command line
Required 3 files.
Loaded suite WordNet
Started
..FF...FF.E.F...FFFFFFFFF
Finished in 0.787878 seconds.

  1) Failure:
test_familiarity_for_testwords_should_all_return_a_fixnum(LexiconTests)
    [./tests/lexicon.tests.rb:92:in `test_familiarity_for_testwords_should_all_return_a_fixnum'
     ./tests/lexicon.tests.rb:88:in `each'
     ./tests/lexicon.tests.rb:88:in `test_familiarity_for_testwords_should_all_return_a_fixnum'
     ./tests/wntestcase.rb:141:in `run']:
<nil> expected to be an instance of
<Fixnum> but was
<NilClass>.

  2) Failure:
test_grep_finds_compound_words(LexiconTests)
    [./tests/lexicon.tests.rb:137:in `test_grep_finds_compound_words'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `[]' for nil:NilClass">
---Backtrace---
./lib/wordnet/lexicon.rb:278:in `grep'
./tests/lexicon.tests.rb:138:in `test_grep_finds_compound_words'
./tests/lexicon.tests.rb:137:in `test_grep_finds_compound_words'
./tests/wntestcase.rb:141:in `run'
---------------

  3) Failure:
test_lookup_synsets(LexiconTests)
    [./tests/lexicon.tests.rb:156:in `test_lookup_synsets'
     ./tests/lexicon.tests.rb:151:in `each'
     ./tests/lexicon.tests.rb:151:in `test_lookup_synsets'
     ./tests/wntestcase.rb:141:in `run']:
<nil> expected to be an instance of
<WordNet::Synset> but was
<NilClass>.

  4) Failure:
test_morphology_of_dictionary_word_should_return_root_word(LexiconTests)
    [./tests/lexicon.tests.rb:104:in `test_morphology_of_dictionary_word_should_return_root_word'
     ./tests/wntestcase.rb:141:in `run']:
<"angry"> expected but was
<nil>.

  5) Error:
test_perl_tests(LexiconTests):
WordNet::LookupError: Failed lookup of synset '00466621%n':No such synset
    ./lib/wordnet/lexicon.rb:239:in `lookup_synsets_by_key'
    ./lib/wordnet/lexicon.rb:238:in `each'
    ./lib/wordnet/lexicon.rb:238:in `lookup_synsets_by_key'
    ./tests/linguawordnet.tests.rb:17:in `test_perl_tests'
    ./tests/wntestcase.rb:141:in `run'

  6) Failure:
test_reverse_morphology_should_return_inverse(LexiconTests)
    [./tests/lexicon.tests.rb:129:in `test_reverse_morphology_should_return_inverse'
     ./tests/wntestcase.rb:141:in `run']:
<nil> expected to be =~
</^angr/>.

  7) Failure:
test_hyponym_traversal_with_no_block_and_false_second_arg_should_return_holonyms_but_not_the_origin(SynsetTests)
    [./tests/synset.tests.rb:208:in `test_hyponym_traversal_with_no_block_and_false_second_arg_should_return_holonyms_but_not_the_origin'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `traverse' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:209:in `test_hyponym_traversal_with_no_block_and_false_second_arg_should_return_holonyms_but_not_the_origin'
./tests/synset.tests.rb:208:in `test_hyponym_traversal_with_no_block_and_false_second_arg_should_return_holonyms_but_not_the_origin'
./tests/wntestcase.rb:141:in `run'
---------------

  8) Failure:
test_hyponym_traversal_with_no_block_should_return_appropriate_hyponyms(SynsetTests)
    [./tests/synset.tests.rb:192:in `test_hyponym_traversal_with_no_block_should_return_appropriate_hyponyms'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `traverse' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:193:in `test_hyponym_traversal_with_no_block_should_return_appropriate_hyponyms'
./tests/synset.tests.rb:192:in `test_hyponym_traversal_with_no_block_should_return_appropriate_hyponyms'
./tests/wntestcase.rb:141:in `run'
---------------

  9) Failure:
test_part_of_speech_should_return_the_symbol_part_of_speech(SynsetTests)
    [./tests/synset.tests.rb:243:in `test_part_of_speech_should_return_the_symbol_part_of_speech'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `part_of_speech' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:243:in `test_part_of_speech_should_return_the_symbol_part_of_speech'
./tests/synset.tests.rb:243:in `test_part_of_speech_should_return_the_symbol_part_of_speech'
./tests/wntestcase.rb:141:in `run'
---------------

 10) Failure:
test_pos_should_return_the_synsets_singlechar_part_of_speech(SynsetTests)
    [./tests/synset.tests.rb:253:in `test_pos_should_return_the_synsets_singlechar_part_of_speech'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `pos' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:253:in `test_pos_should_return_the_synsets_singlechar_part_of_speech'
./tests/synset.tests.rb:253:in `test_pos_should_return_the_synsets_singlechar_part_of_speech'
./tests/wntestcase.rb:141:in `run'
---------------

 11) Failure:
test_relations(SynsetTests)
    [./tests/synset.tests.rb:108:in `test_relations'
     ./tests/synset.tests.rb:105:in `each'
     ./tests/synset.tests.rb:105:in `test_relations'
     ./tests/wntestcase.rb:141:in `run']:
<#<WordNet::Synset:0xfb7945db0/1  (noun): "" ()>>
of type <WordNet::Synset>
expected to respond_to?<:instance_hyponyms>.

 12) Failure:
test_synset_should_respond_to_traverse_method(SynsetTests)
    [./tests/synset.tests.rb:138:in `test_synset_should_respond_to_traverse_method'
     ./tests/wntestcase.rb:141:in `run']:
<nil>
of type <NilClass>
expected to respond_to?<:traverse>.

 13) Failure:
test_traversal_break_after_3_should_include_three_sets_plus_origin(SynsetTests)
    [./tests/synset.tests.rb:225:in `test_traversal_break_after_3_should_include_three_sets_plus_origin'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `traverse' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:226:in `test_traversal_break_after_3_should_include_three_sets_plus_origin'
./tests/synset.tests.rb:225:in `test_traversal_break_after_3_should_include_three_sets_plus_origin'
./tests/wntestcase.rb:141:in `run'
---------------

 14) Failure:
test_traversal_with_false_second_arg_should_not_include_origin(SynsetTests)
    [./tests/synset.tests.rb:172:in `test_traversal_with_false_second_arg_should_not_include_origin'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `traverse' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:173:in `test_traversal_with_false_second_arg_should_not_include_origin'
./tests/synset.tests.rb:172:in `test_traversal_with_false_second_arg_should_not_include_origin'
./tests/wntestcase.rb:141:in `run'
---------------

 15) Failure:
test_traversal_with_true_second_arg_should_include_origin(SynsetTests)
    [./tests/synset.tests.rb:149:in `test_traversal_with_true_second_arg_should_include_origin'
     ./tests/wntestcase.rb:141:in `run']:
Exception raised:
Class: <NoMethodError>
Message: <"undefined method `traverse' for nil:NilClass">
---Backtrace---
./tests/synset.tests.rb:150:in `test_traversal_with_true_second_arg_should_include_origin'
./tests/synset.tests.rb:149:in `test_traversal_with_true_second_arg_should_include_origin'
./tests/wntestcase.rb:141:in `run'
---------------

25 tests, 116 assertions, 14 failures, 1 errors
---------------

sudo ruby install.rb appears to work - but when using the library in a ruby program nil values are returned.

sudo irb

require 'wordnet'
lex = WordNet::Lexicon::new
lex.lookup_synsets("shoe", WordNet::Noun)
=> nil

I'm not sure what I've done wrong up to this point. Hopefully the information I've provided can show it's something wrong on my end.

For those of you looking for the instructions to get you to the point where you can run the installation tests, I've provided the key steps here for installation on Ubuntu 7.04:

  1. Download Berkeley DB from Oracle (MUST BE 4.4 or earlier!)
    wget http://download.oracle.com/berkeley-db/db-4.4.20.tar.gz 
    
  2. untar and install per INSTALL file instructions
  3. Get the ruby bindings for BDB (MUST BE VERSION 0.6.0 - I had core dumps with using any other binding during the convertdb command)
    wget ftp://moulon.inra.fr/pub/ruby/bdb-0.6.0.tar.gz
    
  4. when compiling the bindings point to the proper headers
    ruby extconf.rb --with-db-include=/home/johndoe/db-4.4.20/build_unix
    make
    sudo make install
    
    svn checkout svn://deveiate.org/Ruby-WordNet/trunk
    ruby convertdb.rb /home/johndoe/WordNet-3.0/dict/
    
#3 fixed WordNet::Synset::Pointer doesn't handle new compound pointer types deveiant deveiant

Reported by deveiant, 6 years ago.

Description

Some new compound pointer types (e.g., ~i and @i) have been added in recent releases of the WordNet? data files, and trying to extract pointers from the synset for any word which contains it causes a NoMethodError? to be raised.

Minimal testcase:

require 'wordnet'

lex = WordNet::Lexicon.new
syn = lex.lookup_synsets_by_offset( "04456674%n" )

syn.pointerlist
syn.pointers

And the results of running it:

$ ruby experiments/unhandled_pointer_types.rb 
syn.pointerlist
---------------------------------------------------------------------------
"@i 03730777%n 0000|#p 08029251%n 0000"
---------------------------------------------------------------------------

syn.pointers
---------------------------------------------------------------------------
undefined method `index' for nil:NilClass
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:104:in `initialize'
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:73:in `parse'
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:804:in `pointers'
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:803:in `pointers'
        /usr/lib/ruby/1.8/sync.rb:229:in `synchronize'
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:802:in `pointers'
        /usr/lib/ruby/1.8/sync.rb:229:in `synchronize'
        /Users/ged/source/ruby/WordNet/lib/wordnet/synset.rb:801:in `pointers'
        experiments/unhandled_pointer_types.rb:23
---------------------------------------------------------------------------
#2 fixed Lexicon requires writable data files/directory deveiant deveiant

Reported by deveiant, 6 years ago.

Description

The !WordNet::Lexicon class opens the database files in read/write mode, and so fails if permission don't allow writing:

irb(main):001:0> require 'wordnet'
    ==> true

irb(main):002:0> lex = WordNet::Lexicon.new
BDB::Fatal: DB_ENV->log_put: 10: DB_RUNRECOVERY: Fatal error, run database 
    recovery -- DB_RUNRECOVERY: Fatal error, run database recovery
        from /usr/lib/ruby/site_ruby/1.8/wordnet/lexicon.rb:94:in `initialize'
        from /usr/lib/ruby/site_ruby/1.8/wordnet/lexicon.rb:94:in `initialize'
        from (irb):2

The lexicon should open the database files read-only by default, and open them read/write only if an option is passed to the constructor.

The setters should probably warn if the lexicon is currently read-only.

1 2

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