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>
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>
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>
<sect2 id="zoom.sru.init.behavior">
<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
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>
<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>
</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);
<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>
projects / yaz-moved-to-github.git / blobdiff