Mercurial > p > roundup > code
changeset 8164:dd60d604a852 permission-performance
Document that filter() can return more than just filterspec params
Document that filter() can return retired and exct_match_spec
parameters as well.
Also that the filter() params are incorporated in the database query
rather than filtering the data after it is returned from the database.
Ralf can you verify that this rewite is correct?
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 20 Nov 2024 09:34:56 -0500 |
| parents | d3a1094b15eb |
| children | 25950b620246 b91d8a4e5850 |
| files | doc/reference.txt |
| diffstat | 1 files changed, 8 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/reference.txt Wed Nov 20 09:28:08 2024 -0500 +++ b/doc/reference.txt Wed Nov 20 09:34:56 2024 -0500 @@ -1532,9 +1532,14 @@ The ``filter`` function must return a *list* of dictionaries of parameters of the - `Class.filter <design.html#:~:text=search_matches>`_ call. Results - found during a query executed by an index template are passed - through the filter calls computed by the ``filter`` function. An + `Class.filter <design.html#:~:text=search_matches>`_ call. + This includes filterspec, retired and exact_match_specs. + Note that sort and group parameters of the filter call should + not be set by filter method (they will be overwritten) and the + parameter search_matches must not be set. + + The query executed by an index template is modified by the + parameters computed by the ``filter`` function. An empty list of filter parameters (``[]``) indicates no access. When using a filter, a check function is still needed to test each individual item for visibility. When the filter function is defined