<para>
Each command is described in sub sections to follow.
</para>
+ <refsect2 id="command-info">
+ <title>info</title>
+ <para>
+ Returns version and statistics about the Pazpar2 instance.
+ </para>
+ </refsect2>
<refsect2 id="command-init">
<title>init</title>
<para>
Initializes a session.
Returns session ID to be used in subsequent requests. If
- a server ID is given in the Pazpar2 server section, then a
+ a server ID is given in the Pazpar2 server section, then
that is included in the session ID as suffix after a period (.).
</para>
<para>
<listitem>
<para>
Limits the search to a given set of targets specified by the
- filter. The filter consists a comma separated list of
+ filter. The filter consists of a comma separated list of
<emphasis>setting</emphasis>+<emphasis>operator</emphasis>+<emphasis>args</emphasis>
pairs. The <emphasis>setting</emphasis> is a Pazpar2 setting
(such as <literal>pz:id</literal>).
<para>
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.
+ record is numbered 1. By default startrecs is 0.
</para>
</listitem>
</varlistentry>
the number '0' (decreasing) or '1' (increasing). Default
sort order is decreasing.
Sort field names can be any field name designated as a sort field
- in the pazpar2.cfg file, or the special names 'relevance' and
- 'position'.
+ in the pazpar2.cfg file, or the special names 'relevance',
+ 'retrieval' and 'position'.
+ </para>
+ <para>
+ Sort type 'position' sorts by position/offset for each database.
+ Sort type 'retrieval' sorts by position of retrieval (first record
+ retrieved is 1, second record is 2, etc.).
</para>
<para>
If not specified here or as
supports native sorting in order to get best results. Pazpar2
will trigger a new search if search criteria changes from Pazpar2
to target-based sorting or visa-versa.
- </para>
+ </para>
</listitem>
</varlistentry>
ready to display. Use this to show first records rapidly without
requiring rapid polling.
</para>
+ <para>
+ If block is set to <literal>preferred</literal>, the command will
+ wait until records have been received from all databases with preferred
+ setting
+ </para>
</listitem>
</varlistentry>
the number '0' (decreasing) or '1' (increasing). Default
sort order is decreasing.
Sort field names can be any field name designated as a sort field
- in the pazpar2.cfg file, or the special names 'relevance' and
- 'position'.
+ in the pazpar2.cfg file, or the special names 'relevance',
+ 'retrieval' and 'position'.
+ </para>
+ <para>
+ Sort type 'position' sorts by position/offset for each database.
+ Sort type 'retrieval' sorts by position of retrieval (first record
+ retrieved is 1, second record is 2, etc.).
</para>
<para>
If not specified here or as
</para>
</refsect2>
+ <refsect2 id="command-stop">
+ <title>stop</title>
+ <para>
+ Makes Pazpar2 stop further search & retrieval for busy databases.
+ </para>
+ </refsect2>
+
<refsect2 id="command-termlist">
<title>termlist</title>
<para>