X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzoom.xml;h=5d89f45687e8bfc915016545633628952b59bee6;hp=593c5a187c4dad322272d748f504c3550a3742bc;hb=d940392c53c32ccf76fb287cc5b997b9e921a431;hpb=55ca7cdb58b098d348054917296c0fe2c9cb1580

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 593c5a1..5d89f45 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -20,7 +20,6 @@ ZOOM_options_set_int(opt, name, value)
 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm)
 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 -->
-<!-- $Id: zoom.xml,v 1.56 2007-04-30 08:29:07 adam Exp $ -->
  <chapter id="zoom"><title>ZOOM</title>
   <para>
     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
@@ -38,7 +37,11 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     specified by the value of the connection's <literal>sru</literal>
     option, which may be SRU over HTTP GET (<literal>get</literal>),
     SRU over HTTP POST (<literal>post</literal>) or SRW (SRU over
-    SOAP) (<literal>soap</literal>).
+    SOAP) (<literal>soap</literal>).  Using the facility for embedding
+    options in target strings, a connection can be forced to use SRU
+    rather the SRW (the default) by prefixing the target string with
+    <literal>sru=get,</literal>, like this:
+    <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
    </para>
   </note>
 
@@ -120,7 +123,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
     sequences, each of which represents an option to be set into the
     connection structure <emphasis>before</emphasis> the
-    protocol-level connection is forged and the initialisation
+    protocol-level connection is forged and the initialization
     handshake takes place.  This facility can be used to provide
     authentication credentials, as in host-strings such as:
     <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
@@ -263,6 +266,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	discover whether the server claims to support the specified
 	operations.
        </entry><entry>none</entry></row>
+      <row><entry>
+        sru_version</entry><entry>
+	SRU/SRW version. Should be <literal>1.1</literal>, or
+	<literal>1.2</literal>. This is , prior to connect, the version
+	to offer (highest version). And following connect (in fact
+	first operation), holds the negotiated version with the server
+	(same or lower version).
+       </entry><entry>1.2</entry></row>
      </tbody>
     </tgroup>
    </table>
@@ -740,6 +751,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
         <literal>const char *</literal>. 
        </para></listitem>
      </varlistentry>
+     <varlistentry><term><literal>schema</literal></term>
+      <listitem><para>The schema of the record is returned
+        as a C null-terminated string. Return type is
+        <literal>const char *</literal>. 
+       </para></listitem>
+     </varlistentry>
      <varlistentry><term><literal>render</literal></term>
       <listitem><para>The record is returned in a display friendly
         format. Upon completion buffer is returned
@@ -827,14 +844,16 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
    </para>
 
    <para>
-    The Scan interface is Z39.50 only. SRW version 1.0 does not
-    support this.
+    The Scan interface is supported for both Z39.50 and SRU.
    </para>
 
    <synopsis>
     ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
                                       const char *startpqf);
 
+    ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
+                                       ZOOM_query q);
+
     size_t ZOOM_scanset_size(ZOOM_scanset scan);
 
     const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
@@ -890,6 +909,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
      @attr 1=4 @attr 6=2 "science o"
     </literallayout>
    </para>
+
+   <para>
+    The <function>ZOOM_connecton_scan1</function> is a newer and
+    more generic alternative to <function>ZOOM_connection_scan</function>
+    which allows to use both CQL and PQF for Scan.
+   </para>
    
    <table frame="top" id="zoom.scanset.options">
     <title>ZOOM Scan Set Options</title>
@@ -1045,10 +1070,19 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
        <entry><literal>create</literal></entry>
       </row>
       <row>
+       <entry>waitAction</entry>
+       <entry>
+	Wait action for package. Possible values:
+	<literal>wait</literal>, <literal>waitIfPossible</literal>,
+	<literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
+       </entry>
+       <entry><literal>waitIfPossible</literal></entry>
+      </row>
+      <row>
        <entry>targetReference</entry>
        <entry>
 	Target Reference. This is part of the response as returned
-	by the server. Read it after a succesful operation.
+	by the server. Read it after a successful operation.
        </entry>
        <entry><literal>none</literal></entry>
       </row>
@@ -1132,7 +1166,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	 <literal>recordDelete</literal>,
 	 <literal>elementUpdate</literal>.
 	</entry>
-	<entry><literal>specialUpdate</literal></entry>
+	<entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
        </row>
        <row>
 	<entry>recordIdOpaque</entry>
@@ -1161,6 +1195,35 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	<entry>Database from connection object</entry>
 	<entry>Default</entry>
        </row>
+       <row>
+	<entry>correlationInfo.note</entry>
+	<entry>Correlation Info Note (string)</entry>
+	<entry>none</entry>
+       </row>
+       <row>
+	<entry>correlationInfo.id</entry>
+	<entry>Correlation Info ID (integer)</entry>
+	<entry>none</entry>
+       </row>
+       <row>
+	<entry>elementSetName</entry>
+	<entry>Element Set for Record</entry>
+	<entry>none</entry>
+       </row>
+       <row>
+	<entry>updateVersion</entry>
+	<entry>Record Update version which holds one of the values
+	 1, 2 or 3. Each version has a distinct OID:
+	 1.2.840.10003.9.5
+	 (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
+	 1.2.840.10003.9.5.1 
+	 (second version) and 
+	 1.2.840.10003.9.5.1.1 
+	 (<ulink url="&url.z39.50.extupdate3;">third and
+	  newest version</ulink>).
+	</entry>
+	<entry>3</entry>
+       </row>
       </tbody>
      </tgroup>
     </table>