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

diff --git a/doc/zoom.xml b/doc/zoom.xml
index c371520..74c95f3 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>
@@ -291,13 +293,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	first operation), holds the negotiated version with the server
 	(same or lower version).
        </entry><entry>1.2</entry></row>
-      <row><entry>
+      <row id="zoom.facets.option"><entry>
         facets</entry><entry>
-	A FacetList is comma-separated list of facet, which is defined
-	as <literal>AttributeList</literal>  and a optional FacetTerm
-	(a Term and a frequency). On request the terms is missing.
-	On response the the list contains the terms that the target
-	could collect.
+        Requested or recommend facets may be given before a search is sent.
+        The value of this setting is described in <xref linkend="facets"/>
+        For inspection of the facets returned, refer to the functions
+        described in <xref linkend="zoom.facets"/>.
        </entry><entry>none</entry></row>
       <row><entry>
         apdulog</entry><entry>
@@ -323,6 +324,27 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
 	in call to <function>ZOOM_connection_option_get</function> or
 	<function>ZOOM_connection_option_getl</function>.
        </entry><entry></entry></row>
+      <row><entry>
+        memcached</entry><entry>
+        If given and non-empty,
+        <ulink url="&url.libmemcached;">libMemcached</ulink>
+        will be configured for the connection.
+        This option is inspected by ZOOM when a connection is  established.
+        If the <literal>memcached</literal> option is given
+        and YAZ is compiled without libMemcached support, an internal
+        diagnostic (10018) will be thrown.
+        libMemcached support is available for YAZ 5.0.13 or later. If this
+        option is supplied for an earlier version of YAZ, it is
+        <emphasis>ignored</emphasis>.
+        The value of this option is a string passed verbatim to
+        the <function>memcached</function> function part of libMemcached.
+        Refer to man page
+         <ulink url="http://manned.org/memcached.3">memcached(3)</ulink>.
+        Earlier versions of libMemcached
+        do not offer this function. In this case only the option
+        <literal>--server=</literal><replaceable>host</replaceable> may
+        be given (YAZ emulates that part of libMemcached).
+       </entry><entry>none</entry></row>
      </tbody>
     </tgroup>
    </table>
@@ -389,14 +411,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 +426,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 +795,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 +951,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 +984,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 +1024,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>
@@ -993,19 +1034,19 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
   </sect1>
   <sect1 id="zoom.facets"><title>Facets</title>
    <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.
-    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
-    interate over the terms.
+    Facet operations is not part of the official ZOOM specification, but
+    is an Index Data extension for YAZ-based Z39.50 targets,
+    <ulink url="&url.solr;">Solr</ulink> and SRU 2.0 targets.
+
+    Facets may be requestd by the
+     <link linkend="zoom.facets.option">facets</link> option before a
+    search is sent.
+    For inspection of the returned facets, the following functions are
+    available:
    </para>
    <synopsis>
     ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
 
-    const char ** ZOOM_resultset_facets_names(ZOOM_resultset r);
-
     ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r,
                                                     const char *facet_name);
 
@@ -1027,7 +1068,6 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
     <function>ZOOM_resultset_get_facet_field</function> or
     <function>ZOOM_resultset_get_facet_field_by_index</function>.
     <function>ZOOM_resultset_facets</function>.
-    <function>ZOOM_resultset_facets_names</function>.
     <function>ZOOM_facet_field_name</function>.
     <function>ZOOM_facet_field_get_term</function>.
     </para>
@@ -1075,7 +1115,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 +1626,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