X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=968a7993feea1fade53d4544afa5bc4c692faf08;hb=36fc577568a9ffe8010f4c1fc62279fa8c617c7c;hp=a8dd4f5e99beb2099921b7c733a01648a8222685;hpb=9fcc9c9710afecdf31ca058f4c80f1711891c39e;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index a8dd4f5..968a799 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -37,18 +37,37 @@
This way, a regular webserver can host the user interface (itself dynamic
or static HTML), and Ajax-style calls can be used from JS (or any other
client-based scripting environment) to interact with the search logic
- in Pazpar2.
+ in Pazpar2.
Each command is described in sub sections to follow.
+
+ info
+
+ Returns version and statistics about the Pazpar2 instance.
+
+ init
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
- period (.) and the server ID is appended to the session ID.
+ a server ID is given in the Pazpar2 server section, then
+ that is included in the session ID as suffix after a period (.).
+
+
+ If the init command is performed as a HTTP GET request, service
+ and settings from local files are used. The service parameter
+ may chose a particular local service.
+
+
+ If the init command is performed as a HTTP POST request and
+ the content-type is text/xml, then the content is XML parsed
+ and treated as service for the session. The root element should be
+ service. Refer to descripton of the
+ service format.
+ The posting of a service appeared in Pazpar2 version 1.2.1.
Example:
@@ -94,7 +113,7 @@
-
+
ping
@@ -124,13 +143,15 @@
The settings command applies session-specific settings to one or more
databases. A typical function of this is to enable access to
restricted resources for registered users, or to set a user- or
- library-specific username/password to use against a target. Each
- setting parameter has the form name[target]=value, where name is the
+ library-specific username/password to use against a target.
+
+
+ Each setting parameter has the form name[target]=value, where name is the
name of the setting (e.g. pz:authentication), target is a target ID,
or possibly a wildcard, and value is the desired value for the
setting.
-
+
Because the settings command manipulates potentially sensitive
information, it is possible to configure Pazpar2 to only allow access
@@ -138,14 +159,22 @@
scripting, which in turn is responsible for authenticating the user,
and possibly determining which resources he has access to, etc.
-
+
As a shortcut, it is also possible to override settings directly in
the init command.
-
+
+
+ If the settings command is performed as HTTP POST and the content-type
+ is text/xml, then the content is XML parsed and treated as settings -
+ with a format identical to local
+ settings files.
+ The posting of settings appeared in Pazpar version 1.2.1.
+
+
Example:
]]>
-
+
search
@@ -187,7 +216,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
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
setting+operator+args
pairs. The setting is a Pazpar2 setting
(such as pz:id).
@@ -225,7 +254,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
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.
@@ -240,6 +269,79 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
+
+ sort
+
+
+ Specifies sort criteria. The argument is a comma-separated list
+ (no whitespace allowed) of sort fields, with the highest-priority
+ field first. A sort field may be followed by a colon followed by
+ 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',
+ 'retrieval' and 'position'.
+
+
+ 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.).
+
+
+ If not specified here or as
+ sort-default"
+ 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
+ to target-based sorting or visa-versa.
+
+
+
+
+
+ mergekey
+
+
+ Sets mergekey for this search and rest of session, or until
+ another mergekey is given for show/search. The mergekey value is a
+ comma separated list with one or more names as they appear
+ in the service description equivalent to
+ mergekey="optional" inside a metadata element.
+ If the empty string is given for mergekey it is disabled
+ and rest of session will use the default mergekey from service
+ or stylesheet.
+
+
+ This facility, "dynamic mergekey", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ rank
+
+
+ Sets rank method this search and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
@@ -257,7 +359,7 @@ search.pz2?session=2044502273&command=search&query=computer+science
]]>
-
+
stat
@@ -299,7 +401,7 @@ search.pz2?session=2044502273&command=stat
]]>
-
+
show
@@ -313,14 +415,14 @@ search.pz2?session=2044502273&command=stat
-
+
startFirst record to show - 0-indexed.
-
+
num
@@ -338,6 +440,11 @@ search.pz2?session=2044502273&command=stat
ready to display. Use this to show first records rapidly without
requiring rapid polling.
+
+ If block is set to preferred, the command will
+ wait until records have been received from all databases with preferred
+ setting
+
@@ -348,21 +455,91 @@ search.pz2?session=2044502273&command=stat
Specifies sort criteria. The argument is a comma-separated list
(no whitespace allowed) of sort fields, with the highest-priority
field first. A sort field may be followed by a colon followed by
- the number '0' or '1', indicating whether results should be sorted in
- increasing or decreasing order according to that field. 0==Decreasing is
- the default.
+ 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'.
+
+
+ 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.).
+
+
+ If not specified here or as
+ sort-default"
+ 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
+ to target-based sorting.
- For targets where If pz:sortmap
+ For targets where If pz:sortmap
is defined, a sort operation will be executed (possibly including
extending the search).
-
+
+
+ mergekey
+
+
+ Sets mergekey for this show and rest of session, or until
+ another mergekey is given for show/search. The mergekey value is a
+ comma separated list with one or more names as they appear
+ in the service description equivalent to
+ mergekey="optional" inside a metadata element.
+ If the empty string is given for mergekey it is disabled
+ and rest of session will use the default mergekey from service
+ or stylesheet.
+
+
+ This facility, "dynamic mergekey", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ rank
+
+
+ Sets rank method this show and rest of session, or until
+ another rank is given for show/search. The rank value is a
+ comma separated list of pairs field=value pairs. The
+ format is the same as
+ rank for a metadata element.
+ If the empty string is given for rank it is disabled
+ and rest of session will use the default rank from metadata or
+ stylesheet.
+
+
+ This facility, "dynamic ranking", appeared in Pazpar2 version
+ 1.6.31.
+
+
+
+
+
+ snippets
+
+
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+
+
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+
+
+
+
@@ -381,7 +558,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
2 -- Number of records retrieved
How to program a computer, by Jack Collins
- 2 -- Number of merged records
+ 2 -- Number of merged records
6 -- Record ID for this record
@@ -399,10 +576,10 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
record
- Retrieves a detailed record. Unlike the
- show command, this command
+ Retrieves a detailed record. Unlike the
+ show command, this command
returns metadata records before merging takes place. Parameters:
-
+
session
@@ -482,7 +659,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
syntax
- 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.
@@ -513,16 +690,30 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
+
+ snippets
+
+
+ If specified and set to 1 data will include snippets marked
+ with <match> tags. Otherwise snippets will not be included.
+
+
+ This facility, "snippets", appeared in Pazpar2 version
+ 1.6.32.
+
+
+
+
-
+
Example:
Example output:
-
+
@@ -536,11 +727,18 @@ search.pz2?session=605047297&command=record&id=3
+
+ stop
+
+ Makes Pazpar2 stop further search & retrieval for busy databases.
+
+
+
termlist
Retrieves term list(s). Parameters:
-
+
session
@@ -597,7 +795,7 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
]]>
-
+
For the special termlist name "xtargets", results
are returned about the targets which have returned the most hits.
@@ -618,7 +816,7 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
]]>
-
+
bytarget
@@ -636,14 +834,14 @@ search.pz2?session=2044502273&command=termlist&name=author,subject
-
+
Example:
-
+
Example output:
-
+
OK
@@ -657,7 +855,7 @@ search.pz2?session=605047297&command=bytarget&id=3
]]>
-
+
The following client states are defined: Client_Connecting,
Client_Connected, Client_Idle, Client_Initializing, Client_Searching,
Client_Searching, Client_Presenting, Client_Error, Client_Failed,
@@ -665,6 +863,25 @@ search.pz2?session=605047297&command=bytarget&id=3
+
+ service
+
+ Returns service definition (XML). Parameters:
+
+
+ session
+
+
+ Session ID
+
+
+
+
+
+
+ The service command appeared in Pazpar2 version 1.6.32
+
+ SEE ALSO