ZOOM_diag_str(error)
ZOOM_resultset_record_immediate(s, pos)
ZOOM_resultset_cache_reset(r)
-ZOOM_resultset_sort(r, sort_type, sort_spec)
-ZOOM_resultset_sort1(r, sort_type, sort_spec)
ZOOM_options_set_callback(opt, function, handle)
ZOOM_options_create_with_parent2(parent1, parent2)
ZOOM_options_getl(opt, name, 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>
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>
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
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>
</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>
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 memcached(3). 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>
</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>
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>
More query types will be added in future versions of &yaz;, such as
<link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
etc. In addition to a search, a sort criteria may be set. Function
- <function>ZOOM_query_sortby</function> specifies a
- sort criteria using the same string notation for sort as offered by
- the <link linkend="sortspec">YAZ client</link>.
+ <function>ZOOM_query_sortby</function> enables Z39.50 sorting and
+ it takes sort criteria using the same string notation as
+ yaz-client's <link linkend="sortspec">sort command</link>.
</para>
- <para>
+ <para id="zoom.query.sortby2">
<function>ZOOM_query_sortby2</function> is similar to
<function>ZOOM_query_sortby</function> but allows a strategy for
sorting. The reason for the strategy parameter is that some
<entry>cql</entry><entry>CQL SORTBY</entry>
</row>
<row>
- <entry>sru11</entry><entry>SRU sortKeys element</entry>
+ <entry>sru11</entry><entry>SRU sortKeys parameter</entry>
</row>
<row>
<entry>solr</entry><entry>Solr sort</entry>
</tbody>
</tgroup>
</table>
+
+ <sect2 id="zoom.z3950.resultset.sort">
+ <title>Z39.50 Result-set Sort</title>
+ <synopsis>
+ void ZOOM_resultset_sort(ZOOM_resultset r,
+ const char *sort_type, const char *sort_spec);
+
+ int ZOOM_resultset_sort1(ZOOM_resultset r,
+ const char *sort_type, const char *sort_spec);
+ </synopsis>
+ <para>
+ <function>ZOOM_resultset_sort</function> and
+ <function>ZOOM_resultset_sort1</function> both sort an existing
+ result-set. The sort_type parameter is not use. Set it to "yaz".
+ The sort_spec is same notation as ZOOM_query_sortby and identical
+ to that offered by yaz-client's
+ <link linkend="sortspec">sort command</link>.
+ </para>
+ <para>
+ These functions only work for Z39.50. Use the more generic utility
+ <link linkend="zoom.query.sortby2">
+ <function>ZOOM_query_sortby2</function></link>
+ for other protocols (and even Z39.50).
+ </para>
+ </sect2>
<sect2 id="zoom.z3950.resultset.behavior">
<title>Z39.50 Protocol behavior</title>
<para>
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
</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
<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>
</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>
<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
</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>
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