X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=da8f0a9a5132616ab15c00612d6d228e1790240b;hb=08fcb37b8bac4d5573b6afec27c3f3df4119781f;hp=ebf09ee897b6b63f494678f8ca559c82203f5014;hpb=57b3990d07f7ed994884bc61504eb5a1962526eb;p=yaz-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index ebf09ee..da8f0a9 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -29,22 +29,25 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
programming language or toolkit.
-
-
- A recent addition to &yaz; is SRU support. You can now make
- SRU ZOOM connections by specifying scheme http://
- for the hostname for a connection. The dialect of SRU used is
- specified by the value of the connection's sru
- option, which may be SRU over HTTP GET (get),
- SRU over HTTP POST (post) or SRW (SRU over
- SOAP) (soap). 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
- sru=get,, like this:
+
+ From YAZ version 2.1.12, SRU is supported.
+ You can make SRU ZOOM connections by specifying scheme
+ http:// for the hostname for a connection.
+ The dialect of SRU used is specified by the value of the
+ connection's sru option, which may be SRU over
+ HTTP GET (get),
+ SRU over HTTP POST (post), (SRU over
+ SOAP) (soap) or SOLR
+ (SOLR 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 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
@@ -192,7 +196,15 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
It's automatically set internally when connecting to a target.
none
- proxyProxy host
+ proxyProxy host. If set, the logical host
+ is encoded in the otherInfo area of the Z39.50 Init PDU
+ with OID 1.2.840.10003.10.1000.81.1.
+ none
+
+ clientIPClient IP. If set, is
+ encoded in the otherInfo area of a Z39.50 PDU with OID
+ 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
+ of a client. Is used of ZOOM is used in a gateway of some sort.
none
asyncIf true (1) the connection operates in
@@ -266,11 +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,
- get or post.
- soap
+
+ sru
+ SRU/SOLR transport type. Must be either soap,
+ get, post, or
+ solr.
+ soap
sru_version
SRU/SRW version. Should be 1.1, or
@@ -279,6 +292,14 @@ 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).
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.
+ none
@@ -345,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.
@@ -650,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
@@ -726,7 +750,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
The type is a string of the format:
- form[; charset=from[,to]]
+ form[;charset=from[,to]][;format=v]
where form specifies the format of the
@@ -739,6 +763,12 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
If to is omitted UTF-8 is assumed.
+ The format argument controls whether record data should be XML
+ pretty-printed (post process operation).
+ It is enabled only if format value v is
+ 1 and the record content is XML well-formed.
+
+
In addition, for certain types, the length
len passed will be set to the size in bytes of
the returned information.
@@ -786,7 +816,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
xmlThe 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
@@ -806,6 +836,19 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
OPAC record is present, a NULL pointer is returned.
+ txml
+ The record is returned in TurboMARC if possible.
+ SRU and Z39.50 records with transfer syntax XML are
+ returned verbatim. MARC records are returned in
+
+ TurboMARC
+
+ (converted from ISO2709 to TurboMARC by YAZ).
+ Upon completion, the XML buffer is returned
+ (type const char *) and length is stored in
+ *len.
+
+
@@ -840,14 +883,68 @@ 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.
+ 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.
+
+
+ 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);
+ ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
+ size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
+
+ const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
+ size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
+ const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
+
+
+ References to temporary structures are returned by all functions. They are only valid as long the Result set is valid.
+ 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.
+
+
+ A single Facet field is returned by function
+ ZOOM_resultset_get_facet_field or ZOOM_resultset_get_facet_field_by_index that takes a
+ result set and facet name or positive index respectively. First facet has position zero.
+ If no facet could be obtained (invalid name or index out of bounds) NULL is returned.
+
+
+ An array of facets field can be returned by ZOOM_resultset_facets. The length of the array is
+ given by ZOOM_resultset_facets_size. The array is zero-based and last entry will be at
+ ZOOM_resultset_facets_size(result_set)-1.
+
+
+ It is possible to interate over facets by name, by calling ZOOM_resultset_facets_names.
+ This will return an const array of char * where each string can be used as parameter for
+ ZOOM_resultset_get_facet_field.
+
+
+ Function ZOOM_facet_field_name gets the request facet name from a returned facet field.
+
+
+ Function ZOOM_facet_field_get_term returns the idx'th term and term count for a facet field.
+ Idx must between 0 and ZOOM_facet_field_term_count-1, otherwise the returned reference will be
+ NULL. On a valid idx, the value of the freq reference will be the term count.
+ The *freq parameter must be valid pointer to integer.
+
+ Scan
This section describes an interface for Scan. Scan is not an
@@ -857,7 +954,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?).
@@ -946,7 +1043,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
numberNumber of Scan Terms requested in next scan.
After scan it holds the actual number of terms returned.
- 10
+ 20
positionPreferred Position of term in response
in next scan; actual position after completion of scan.