<refentryinfo>
<productname>Pazpar2</productname>
<productnumber>&version;</productnumber>
- <info><orgname>Index Data</orgname></info>
+ <orgname>Index Data</orgname>
</refentryinfo>
<refmeta>
<refentrytitle>Pazpar2 protocol</refentrytitle>
<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>
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
<bytarget>
<status>OK</status>
<target>
- <id>z3950.loc.gov/voyager/</id>
+ <id>lx2.loc.gov/LCDB/</id>
<hits>10000</hits>
<diagnostic>0</diagnostic>
<records>65</records>