<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>
</variablelist>
</para>
</refsect2>
-
+
<refsect2 id="command-ping">
<title>ping</title>
<para>
or possibly a wildcard, and value is the desired value for the
setting.
</para>
-
+
<para>
Because the settings command manipulates potentially sensitive
information, it is possible to configure Pazpar2 to only allow access
scripting, which in turn is responsible for authenticating the user,
and possibly determining which resources he has access to, etc.
</para>
-
+
<note>
<para>
As a shortcut, it is also possible to override settings directly in
</settings>
]]></screen>
</para>
-
+
</refsect2>
<refsect2 id="command-search">
<title>search</title>
<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>
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking.
+ 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>
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. Pazpar2
- will trigger a new search if search criteria changes from Pazpar2
+ If not specified here or as
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, Pazpar2 will default to the built-in
+ 'relevance' ranking.
+ </para>
+ <para>
+ Having sort criteria at search is important for targets that
+ 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>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-stat">
<title>stat</title>
<para>
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-show">
<title>show</title>
<para>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>start</term>
<listitem>
<para>First record to show - 0-indexed.</para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>num</term>
<listitem>
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'.
-
- If not specified here or as <link linkend="sort-default">sort-default"</link>
- in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking.
-
- Having sort criteria at search is important for targets that
- supports native sorting in order to get best results. pazpar2
- will trigger a new search if search criteria changes from pazpar2
+ 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
+ <link linkend="sort-default">sort-default"</link>
+ in pazpar2.cfg, pazpar2 will default to the built-in
+ 'relevance' ranking.
+ </para>
+ <para>
+ Having sort criteria at search is important for targets that
+ 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.
-
</para>
<para>
For targets where If <link linkend="pzsortmap">pz:sortmap</link>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>snippets</term>
+ <listitem>
+ <para>
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+ </para>
+ <para>
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
<para>
<num>2</num> -- Number of records retrieved
<hit>
<md-title>How to program a computer, by Jack Collins</md-title>
- <count>2</count> -- Number of merged records
+ <count>2</count> -- Number of merged records
<recid>6</recid> -- Record ID for this record
</hit>
<hit>
<refsect2 id="command-record">
<title>record</title>
<para>
- Retrieves a detailed record. Unlike the
- <link linkend="command-show">show</link> command, this command
+ Retrieves a detailed record. Unlike the
+ <link linkend="command-show">show</link> command, this command
returns metadata records before merging takes place. Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
<term>syntax</term>
<listitem>
<para>
- This optional parameter is the record syntax used for raw
+ This optional parameter is the record syntax used for raw
transfer (i.e. when offset is specified). If syntax is not given,
but offset is used, the value of pz:requestsyntax is used.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>snippets</term>
+ <listitem>
+ <para>
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+ </para>
+ <para>
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=record&id=3
]]></screen>
Example output:
-
+
<screen><![CDATA[
<record>
<md-title>
</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>
Retrieves term list(s). Parameters:
-
+
<variablelist>
<varlistentry>
<term>session</term>
</termlist>
]]></screen>
</para>
-
+
<para>
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
]]></screen>
</para>
</refsect2>
-
+
<refsect2 id="command-bytarget">
<title>bytarget</title>
</varlistentry>
</variablelist>
</para>
- <para>
+ <para>
Example:
<screen><![CDATA[
search.pz2?session=605047297&command=bytarget&id=3
]]></screen>
-
+
Example output:
-
+
<screen><![CDATA[
<bytarget>
<status>OK</status>
<!-- ... more target nodes below as necessary -->
</bytarget>
]]></screen>
-
+
The following client states are defined: Client_Connecting,
Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
Client_Searching, Client_Presenting, Client_Error, Client_Failed,
projects / pazpar2-moved-to-github.git / blobdiff