X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzoom.xml;h=d1ccf8ea0424acab2bfa9187387a3276778d8a55;hp=c371520e2878e36b2b610b73c8a530a9a5ade4b0;hb=8bcd70cb460d7a11175e82487f498102ead66472;hpb=def193190d4979179d1d216c77f9d61d8865e234

diff --git a/doc/zoom.xml b/doc/zoom.xml
index c371520..d1ccf8e 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -16,7 +16,6 @@ ZOOM_options_setl(opt, name, value, len)
 ZOOM_options_get_bool(opt, name, defa)
 ZOOM_options_get_int(opt, name, defa)
 ZOOM_options_set_int(opt, name, value)
-ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 -->
  <chapter id="zoom"><title>ZOOM</title>
   <para>
@@ -35,15 +34,15 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     connection's <literal>sru</literal> option, which may be SRU over
     HTTP GET (<literal>get</literal>),
     SRU over HTTP POST (<literal>post</literal>), (SRU over
-    SOAP) (<literal>soap</literal>) or <literal>SOLR</literal>
-    (<ulink url="&url.solr;">SOLR</ulink> Web Service).
+    SOAP) (<literal>soap</literal>) or <literal>solr</literal>
+    (<ulink url="&url.solr;">Solr</ulink> Web Service).
     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>
   <para>
-   <ulink url="&url.solr;">SOLR</ulink>  protocol support was added to
+   <ulink url="&url.solr;">Solr</ulink>  protocol support was added to
    YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
    HTTP based protocols.
   </para>
@@ -118,7 +117,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     You can prefix the host with a scheme followed by colon. The
     default scheme is <literal>tcp</literal> (Z39.50 protocol).
     The scheme <literal>http</literal> selects SRU/get over HTTP by default,
-    but can overridded to use SRU/post, SRW and the SOLR protocol.
+    but can overridded to use SRU/post, SRW and the Solr protocol.
    </para>
    <para>
     You can prefix the scheme-qualified host-string with one or more
@@ -191,6 +190,9 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
         password</entry><entry>Authentication password.
        </entry><entry>none</entry></row>
       <row><entry>
+        authenticationMode</entry><entry>How authentication is encoded.
+       </entry><entry>basic</entry></row>
+      <row><entry>
         host</entry><entry>Target host. This setting is "read-only".
         It's automatically set internally when connecting to a target.
        </entry><entry>none</entry></row>
@@ -279,7 +281,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
        </entry><entry>none</entry></row>
       <row>
 	<entry>sru</entry><entry>
-	SRU/SOLR transport type. Must be either <literal>soap</literal>,
+	SRU/Solr transport type. Must be either <literal>soap</literal>,
 	<literal>get</literal>, <literal>post</literal>, or
 	<literal>solr</literal>.
         </entry><entry>soap</entry></row>
@@ -389,14 +391,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     </para>
     </sect2>
    <sect2 id="zoom.sru.init.behavior">
-    <title>SRU/SOLR Protocol behavior</title>
+    <title>SRU/Solr Protocol behavior</title>
     <para>
-     The HTTP based protocols (SRU, SRW, SOLR) doesn't feature an Inititialize Request, so
-     the connection phase merely establishes a TCP/IP connection
-     with the SOAP service.
+     The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
+     Inititialize Request, so  the connection phase merely establishes a
+     TCP/IP connection with the HTTP server.
     </para>
     <para>Most of the ZOOM connection options do not
-     affect SRU/SOLR and they are ignored. However, future versions
+     affect SRU/Solr and they are ignored. However, future versions
      of &yaz; might honor <literal>implementationName</literal> and
      put that as part of User-Agent header for HTTP requests.
      </para>
@@ -404,6 +406,19 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
      The <literal>charset</literal> is used in the Content-Type header
      of HTTP requests.
     </para>
+    <para>
+     Setting <literal>authentcationMode</literal> specifies how
+     authentication parameters are encoded for HTTP. The default is
+     "<literal>basic</literal>" where <literal>user</literal> and
+     <literal>password</literal> are encoded by using HTTP basic
+     authentication.
+     </para>
+    <para>
+     If <literal>authentcationMode</literal> is "<literal>url</literal>", then
+     user and password are encoded in the URL by parameters
+     <literal>x-username</literal> and <literal>x-password</literal> as
+     given by the SRU standard.
+    </para>
    </sect2>
   </sect1>
   <sect1 id="zoom.query"><title>Queries</title>
@@ -760,10 +775,10 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
      SRU SearchRetrieveRequest.
     </para>
     <para>
-     SOLR queries has to be done in SOLR query format.
+     Solr queries has to be done in Solr query format.
     </para>
     <para>
-     Unfortunately, SRU or SOLR does not define a database setting. Hence,
+     Unfortunately, SRU or Solr does not define a database setting. Hence,
      <literal>databaseName</literal> is unsupported and ignored.
      However, the path part in host parameter for functions
      <function>ZOOM_connecton_new</function> and
@@ -916,7 +931,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
      </varlistentry>
      <varlistentry><term><literal>xml</literal></term>
       <listitem><para>The record is returned in XML if possible.
-	SRU, SOLR and Z39.50 records with transfer syntax XML are
+	SRU, Solr and Z39.50 records with transfer syntax XML are
 	returned verbatim. MARC records are returned in
 	<ulink url="&url.marcxml;">
 	 MARCXML
@@ -949,6 +964,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
         <literal>*len</literal>.
        </para></listitem>
      </varlistentry>
+     <varlistentry><term><literal>json</literal></term>
+      <listitem><para>Like xml, but MARC records are converted to
+	<ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>.
+       </para></listitem>
+     </varlistentry>
+
     </variablelist>
    </para>
    <para>
@@ -983,9 +1004,9 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     </para>
    </sect2>
    <sect2 id="zoom.sru.record.behavior">
-    <title>SRU/SOLR Protocol behavior</title>
+    <title>SRU/Solr Protocol behavior</title>
     <para>
-     The ZOOM driver for SRU/SOLR treats records returned by a SRU/SOLR server
+     The ZOOM driver for SRU/Solr treats records returned by a SRU/Solr server
      as if they where Z39.50 records with transfer syntax XML and
      no element set name or database name.
     </para>
@@ -995,7 +1016,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
    <para>
     Facets operations is not part of the official ZOOM specification, but
     is an Index Data extension for YAZ-based Z39.50 targets or
-    <ulink url="&url.solr;">SOLR</ulink> targets.
+    <ulink url="&url.solr;">Solr</ulink> targets.
     In case the target can and is requested to return facets, using a
     result set the ZOOM client can request one or all facet fields.
     Using a facet field the client can request the term count and then
@@ -1075,7 +1096,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
    </para>
 
    <para>
-    The Scan interface is supported for both Z39.50, SRU (and SOLR?).
+    The Scan interface is supported for both Z39.50, SRU and Solr.
    </para>
 
    <synopsis>
@@ -1586,6 +1607,38 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
                                        void *handle);
    </synopsis>
   </sect1>
+
+  <sect1 id="zoom.queryconversions"><title>Query conversions</title>
+   <synopsis>
+    int ZOOM_query_cql2rpn(ZOOM_query s, const char *cql_str,
+                           ZOOM_connection conn);
+
+    int ZOOM_query_ccl2rpn(ZOOM_query s, const char *ccl_str,
+                           const char *config,
+                           int *ccl_error, const char **error_string,
+                           int *error_pos);
+   </synopsis>
+   <para>
+    <function>ZOOM_query_cql2rpn</function> translates the CQL string,
+    client-side, into RPN which may be passed to the server.
+    This is useful for server's that don't themselves
+    support CQL, for which <function>ZOOM_query_cql</function> is useless.
+    `conn' is used  only as a place to stash diagnostics if compilation
+    fails; if this information is not needed, a null pointer may be used.
+    The CQL conversion is driven by option <literal>cqlfile</literal> from
+    connection conn. This specifies a conversion file (eg pqf.properties)
+    which <emphasis>must</emphasis> be present.
+   </para>
+   <para>
+    <function>ZOOM_query_ccl2rpn</function> translates the CCL string,
+    client-side, into RPN which may be passed to the server.
+    The conversion is driven by the specification given by
+    <literal>config</literal>. Upon completion 0 is returned on success; -1
+    is returned on on failure. Om failure <literal>error_string</literal> and
+    <literal>error_pos</literal> holds error message and position of
+    first error in original CCL string.
+   </para>
+  </sect1>
   <sect1 id="zoom.events"><title>Events</title>
    <para>
     If you're developing non-blocking applications, you have to deal