X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=74c95f36fade78fe9344626f42a699e3921b34bb;hb=28a4fb36e751de91911b02fa76eba1f1caa284f5;hp=930d979a7a5887750f0f0ffd9b5ec44a9d57cbb7;hpb=1871ec21035e62b527bbb609a40f019794e43387;p=yaz-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 930d979..74c95f3 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -190,6 +190,9 @@ ZOOM_options_set_int(opt, name, value)
passwordAuthentication password.
none
+ authenticationModeHow authentication is encoded.
+ basic
+
hostTarget host. This setting is "read-only".
It's automatically set internally when connecting to a target.
none
@@ -290,13 +293,12 @@ ZOOM_options_set_int(opt, name, value)
first operation), holds the negotiated version with the server
(same or lower version).
1.2
-
+
facets
- A FacetList is comma-separated list of facet, which is defined
- as AttributeList 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
+ For inspection of the facets returned, refer to the functions
+ described in .
none
apdulog
@@ -322,6 +324,27 @@ ZOOM_options_set_int(opt, name, value)
in call to ZOOM_connection_option_get or
ZOOM_connection_option_getl.
+
+ memcached
+ If given and non-empty,
+ libMemcached
+ will be configured for the connection.
+ This option is inspected by ZOOM when a connection is established.
+ If the memcached 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
+ ignored.
+ The value of this option is a string passed verbatim to
+ the memcached 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
+ --server=host may
+ be given (YAZ emulates that part of libMemcached).
+ none
@@ -390,9 +413,9 @@ ZOOM_options_set_int(opt, name, value)
SRU/Solr Protocol behavior
- 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.
Most of the ZOOM connection options do not
affect SRU/Solr and they are ignored. However, future versions
@@ -403,6 +426,19 @@ ZOOM_options_set_int(opt, name, value)
The charset is used in the Content-Type header
of HTTP requests.
+
+ Setting authentcationMode specifies how
+ authentication parameters are encoded for HTTP. The default is
+ "basic" where user and
+ password are encoded by using HTTP basic
+ authentication.
+
+
+ If authentcationMode is "url", then
+ user and password are encoded in the URL by parameters
+ x-username and x-password as
+ given by the SRU standard.
+ Queries
@@ -948,6 +984,12 @@ ZOOM_options_set_int(opt, name, value)
*len.
+ json
+ Like xml, but MARC records are converted to
+ MARC-in-JSON.
+
+
+
@@ -992,19 +1034,19 @@ ZOOM_options_set_int(opt, name, value)
Facets
- Facets operations is not part of the official ZOOM specification, but
- is an Index Data extension for YAZ-based Z39.50 targets or
- Solr 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,
+ Solr and SRU 2.0 targets.
+
+ Facets may be requestd by the
+ facets option before a
+ search is sent.
+ For inspection of the returned facets, the following functions are
+ available:
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);
@@ -1026,7 +1068,6 @@ ZOOM_options_set_int(opt, name, value)
ZOOM_resultset_get_facet_field or
ZOOM_resultset_get_facet_field_by_index.
ZOOM_resultset_facets.
- ZOOM_resultset_facets_names.
ZOOM_facet_field_name.
ZOOM_facet_field_get_term.