data/TWiki/TWikiQueryHoistREsDotPm.txt
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/TWikiQueryHoistREsDotPm.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,19 @@
     1.4 +---+ Package =TWiki::Query::HoistREs=
     1.5 +
     1.6 +Static functions to extract regular expressions from queries. The REs can
     1.7 +be used in caching stores that use the TWiki standard inline meta-data
     1.8 +representation to pre-filter topic lists for more efficient query matching.
     1.9 +
    1.10 +See =Store/RcsFile.pm= for an example of usage.
    1.11 +
    1.12 +
    1.13 +%TOC%
    1.14 +
    1.15 +---++ ObjectMethod *hoist* <tt>($query) -> @res</tt>
    1.16 +
    1.17 +Extract useful filter REs from the given query. The list returned is a list
    1.18 +of filter expressions that can be used with a cache search to refine the
    1.19 +list of topics. The full query should still be applied to topics that remain
    1.20 +after the filter match has been applied; this is purely an optimisation.
    1.21 +
    1.22 +