X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzoom.xml;h=8a6bb92af30e2cdd1e9eb7a410dd30b9ae2901e7;hp=7d043d2e1bbdfe58786d80437d4ef8906d103bde;hb=554423d357ed2bcf4ece977f85de3bc1307d6536;hpb=5b2fe23e1cffff1c658bdfe26fddc3f84256e7f4
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 7d043d2..8a6bb92 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -43,8 +43,11 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
connection can be forced to use SRU rather the SRW (the default) by
prefixing the target string with sru=get,, like this:
sru=get,http://sru.miketaylor.org.uk:80/sru.pl
-
-
+
+
+ SOLR protocol support was added to YAZ in version 4.1.0,
+ as a dialect of a SRU protocol, since both are HTTP based protocols.
+
The lack of a simple Z39.50 client API for &yaz; has become more
and more apparent over time. So when the first &zoom; specification
@@ -115,7 +118,8 @@ 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 tcp (Z39.50 protocol).
- The scheme http selects SRU over HTTP.
+ The scheme http selects SRU/get over HTTP by default,
+ but can overridded to use SRU/post, SRW and the SOLR protocol.
You can prefix the scheme-qualified host-string with one or more
@@ -274,12 +278,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
discover whether the server claims to support the specified
operations.
none
-
- sru
- SRU transport type. Must be either soap,
+
+ sru
+ SRU/SOLR transport type. Must be either soap,
get, post, or
solr.
- soap
+ soap
sru_version
SRU/SRW version. Should be 1.1, or
@@ -362,14 +366,14 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- SRU Protocol behavior
+ SRU/SOLR Protocol behavior
- The SRU protocol doesn't feature an Inititialize Request, so
+ 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.
Most of the ZOOM connection options do not
- affect SRU and they are ignored. However, future versions
+ affect SRU/SOLR and they are ignored. However, future versions
of &yaz; might honor implementationName and
put that as part of User-Agent header for HTTP requests.
@@ -667,7 +671,10 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
SRU SearchRetrieveRequest.
- Unfortunately, SRU does not define a database setting. Hence,
+ SOLR queries has to be done in SOLR query format.
+
+
+ Unfortunately, SRU or SOLR does not define a database setting. Hence,
databaseName is unsupported and ignored.
However, the path part in host parameter for functions
ZOOM_connecton_new and
@@ -743,18 +750,29 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
The type is a string of the format:
- form[;charset=from[,to]][;format=v]
+ format[;charset=from[/opacfrom][,to]][;format=v]
- where form specifies the format of the
+ where format specifies the format of the
returned record, from
specifies the character set of the record in its original form
(as returned by the server), to specifies
the output (returned)
character set encoding.
- If charset is not given, then no character set conversion takes place.
If to is omitted UTF-8 is assumed.
+ If charset is not given, then no character set conversion takes place.
+
+
+ OPAC records may be returned in a different
+ set from the bibliographic MARC record. If this is this the case,
+ opacfrom should be set to the character set
+ of the OPAC record part.
+
+
+ Specifying the OPAC record character set requires YAZ 4.1.5 or later.
+
+
The format argument controls whether record data should be XML
pretty-printed (post process operation).
@@ -809,7 +827,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
xml
The record is returned in XML if possible.
- SRU 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
MARCXML
@@ -876,9 +894,9 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- SRU Protocol behavior
+ SRU/SOLR Protocol behavior
- The ZOOM driver for SRU treats records returned by a SRU 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.
@@ -886,6 +904,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
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.
@@ -945,7 +965,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
- The Scan interface is supported for both Z39.50 and SRU.
+ The Scan interface is supported for both Z39.50, SRU (and SOLR?).