From f5fe92a40046dd1142edd3714dc3c6c708c26492 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Tue, 13 Oct 2009 11:21:26 +0200 Subject: [PATCH] Describe filter,maxrecs,startrecs --- doc/pazpar2_protocol.xml | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 924c6e7..009635b 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -177,7 +177,36 @@ filter - Filtering. + Limits the search to a given set of targets specified by the + filter. The filter consists a comma separated list of + setting+operator+args pairs. The setting is a Pazpar2 setting + (such as pz:id). + The operator is either = (string match) + or ~ (substring match). The args is a list of values separated + by | (or , one of the values). The idea is that only targets + with a setting matching one of the values given will be included + in the search. + + + + + startrecs + + + Specifies the first record to retrieve from each target. + The first record in a result set for a target is numbered 0, next + record is numbered 2. By default maxrecs is 0. + + + + + maxrecs + + + Specifies the maximum number of records to retrieve from each + target. The default value is 100. This setting has same meaning + as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes + precedence over argument maxrecs. -- 1.7.10.4