X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=968a7993feea1fade53d4544afa5bc4c692faf08;hb=64dccf5757a22cedd3c21ca834e3e02f39dd0504;hp=12ad723929ee24b113f68b8d136299fa2ddcc538;hpb=36afcbab037965e2ca1ac6fcc6a8796ec56e4726;p=pazpar2-moved-to-github.git
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 12ad723..968a799 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -42,6 +42,12 @@
Each command is described in sub sections to follow.
+
+ info
+
+ Returns version and statistics about the Pazpar2 instance.
+
+
init
@@ -273,8 +279,13 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
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
@@ -287,7 +298,7 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
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.
-
+
@@ -429,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
+
@@ -442,8 +458,13 @@ search.pz2?session=2044502273&command=stat
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
@@ -706,6 +727,13 @@ search.pz2?session=605047297&command=record&id=3
+
+ stop
+
+ Makes Pazpar2 stop further search & retrieval for busy databases.
+
+
+
termlist