data/TWiki/TWikiQueryHoistREsDotPm.txt
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 ---+ Package =TWiki::Query::HoistREs=
       
     2 
       
     3 Static functions to extract regular expressions from queries. The REs can
       
     4 be used in caching stores that use the TWiki standard inline meta-data
       
     5 representation to pre-filter topic lists for more efficient query matching.
       
     6 
       
     7 See =Store/RcsFile.pm= for an example of usage.
       
     8 
       
     9 
       
    10 %TOC%
       
    11 
       
    12 ---++ ObjectMethod *hoist* <tt>($query) -> @res</tt>
       
    13 
       
    14 Extract useful filter REs from the given query. The list returned is a list
       
    15 of filter expressions that can be used with a cache search to refine the
       
    16 list of topics. The full query should still be applied to topics that remain
       
    17 after the filter match has been applied; this is purely an optimisation.
       
    18 
       
    19