programming language or toolkit.
</para>
- <note>
- <para>
- A recent addition to &yaz; is SRU support. You can now make
- SRU ZOOM connections by specifying scheme <literal>http://</literal>
- for the hostname for a connection. The dialect of SRU used is
- specified by the value of the connection's <literal>sru</literal>
- option, which may be SRU over HTTP GET (<literal>get</literal>),
- SRU over HTTP POST (<literal>post</literal>) or SRW (SRU over
- SOAP) (<literal>soap</literal>). 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:
+ <para>
+ From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
+ You can make SRU ZOOM connections by specifying scheme
+ <literal>http://</literal> for the hostname for a connection.
+ The dialect of SRU used is specified by the value of the
+ 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).
+ 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>
- </note>
-
+ </para>
+ <para>
+ <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>
<para>
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
<ulink url="&url.zoom;">ZOOM web-site</ulink> for
more information.
</para>
-
+
<para>
In order to fully understand this chapter you should read and
try the example programs <literal>zoomtst1.c</literal>,
<literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
directory.
</para>
-
+
<para>
The C language misses features found in object oriented languages
such as C++, Java, etc. For example, you'll have to manually,
protocol.
</para>
<sect1 id="zoom-connections"><title>Connections</title>
-
+
<para>The Connection object is a session with a target.
</para>
<synopsis>
#include <yaz/zoom.h>
-
+
ZOOM_connection ZOOM_connection_new (const char *host, int portnum);
-
+
ZOOM_connection ZOOM_connection_create (ZOOM_options options);
-
+
void ZOOM_connection_connect(ZOOM_connection c, const char *host,
int portnum);
void ZOOM_connection_destroy(ZOOM_connection c);
</synopsis>
<para>
Connection objects are created with either function
- <function>ZOOM_connection_new</function> or
+ <function>ZOOM_connection_new</function> or
<function>ZOOM_connection_create</function>.
The former creates and automatically attempts to establish a network
connection with the target. The latter doesn't establish
a connection immediately, thus allowing you to specify options
before establishing network connection using the function
- <function>ZOOM_connection_connect</function>.
+ <function>ZOOM_connection_connect</function>.
If the port number, <literal>portnum</literal>, is zero, the
<literal>host</literal> is consulted for a port specification.
If no port is given, 210 is used. A colon denotes the beginning of
<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 over HTTP.
+ The scheme <literal>http</literal> selects SRU/get over HTTP by default,
+ 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
The functions <function>ZOOM_connection_option_set</function> and
<function>ZOOM_connection_option_setl</function> allows you to
set an option given by <parameter>key</parameter> to the value
- <parameter>value</parameter> for the connection.
+ <parameter>value</parameter> for the connection.
For <function>ZOOM_connection_option_set</function>, the
value is assumed to be a 0-terminated string. Function
<function>ZOOM_connection_option_setl</function> specifies a
It's automatically set internally when connecting to a target.
</entry><entry>none</entry></row>
<row><entry>
- proxy</entry><entry>Proxy host
+ proxy</entry><entry>Proxy 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.
+ </entry><entry>none</entry></row>
+ <row><entry>
+ clientIP</entry><entry>Client 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.
</entry><entry>none</entry></row>
<row><entry>
- async</entry><entry>If true (1) the connection operates in
+ async</entry><entry>If true (1) the connection operates in
asynchronous operation which means that all calls are non-blocking
except
<link linkend="zoom.events"><function>ZOOM_event</function></link>.
discover whether the server claims to support the specified
operations.
</entry><entry>none</entry></row>
- <row><entry>
- sru</entry><entry>
- SRU transport type. Must be either <literal>soap</literal>,
- <literal>get</literal> or <literal>post</literal>.
- </entry><entry>soap</entry></row>
+ <row>
+ <entry>sru</entry><entry>
+ 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>
<row><entry>
sru_version</entry><entry>
SRU/SRW version. Should be <literal>1.1</literal>, or
first operation), holds the negotiated version with the server
(same or lower version).
</entry><entry>1.2</entry></row>
+ <row><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.
+ </entry><entry>none</entry></row>
+ <row><entry>
+ apdulog</entry><entry>
+ If set to a true value such as "1", a log of low-level
+ protocol packets is emitted on standard error stream. This
+ can be very useful for debugging.
+ </entry><entry>0</entry></row>
+ <row><entry>
+ saveAPDU</entry><entry>
+ If set to a true value such as "1", a log of low-level
+ protocol packets is saved. The log can be retrieved by reading
+ option APDU. Setting saveAPDU always has the side effect of
+ resetting the currently saved log. This setting is
+ <emphasis>write-only</emphasis>. If read, NULL will be returned.
+ It is only recognized in
+ <function>ZOOM_connection_option_set</function>.
+ </entry><entry>0</entry></row>
+ <row><entry>
+ APDU</entry><entry>
+ Returns the log of protocol packets. Will be empty if logging
+ is not enabled (see saveAPDU above). This setting is
+ <emphasis>read-only</emphasis>. It is only recognized if used
+ in call to <function>ZOOM_connection_option_get</function> or
+ <function>ZOOM_connection_option_getl</function>.
+ </entry><entry></entry></row>
</tbody>
</tgroup>
</table>
<para>
If either option <literal>lang</literal> or <literal>charset</literal>
- is set, then
+ is set, then
<ulink url="&url.z39.50.charneg;">
Character Set and Language Negotiation</ulink> is in effect.
</para>
</para>
</sect2>
<sect2 id="zoom.sru.init.behavior">
- <title>SRU Protocol behavior</title>
+ <title>SRU/SOLR Protocol behavior</title>
<para>
- 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.
</para>
<para>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 <literal>implementationName</literal> and
put that as part of User-Agent header for HTTP requests.
</para>
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
+ <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>.
</para>
The number of hits also called result-count is returned by
function <function>ZOOM_resultset_size</function>.
</para>
- <table id="zoom.resultset.options"
+ <table id="zoom.resultset.options"
frame="top"><title>ZOOM Result set Options</title>
<tgroup cols="3">
<colspec colwidth="4*" colname="name"></colspec>
</thead>
<tbody>
<row><entry>
- start</entry><entry>Offset of first record to be
+ start</entry><entry>Offset of first record to be
retrieved from target. First record has offset 0 unlike the
protocol specifications where first record has position 1.
This option affects ZOOM_resultset_search and
function ZOOM_resultset_records should be used.
</entry><entry>0</entry></row>
<row><entry>
- count</entry><entry>Number of records to be retrieved.
+ count</entry><entry>Number of records to be retrieved.
This option affects ZOOM_resultset_search and
ZOOM_resultset_search_pqf and must be set before any of
these functions are invoked.
option is also supported for the benefit of old applications.)
</entry><entry>0</entry></row>
<row><entry>
- elementSetName</entry><entry>Element-Set name of records.
+ elementSetName</entry><entry>Element-Set name of records.
Most targets should honor element set name <literal>B</literal>
and <literal>F</literal> for brief and full respectively.
</entry><entry>none</entry></row>
</para>
<para>
This information is a list of of items, where each item is
- information about a term or subquery. All items in the list
- are prefixed by
+ information about a term or subquery. All items in the list
+ are prefixed by
<literal>SearchResult.</literal><replaceable>no</replaceable>
- where no presents the item number (0=first, 1=second).
+ where no presents the item number (0=first, 1=second).
Read <literal>searchresult.size</literal> to determine the
number of items.
</para>
- <table id="zoom.search.info.report.options"
+ <table id="zoom.search.info.report.options"
frame="top"><title>Search Info Report Options</title>
<tgroup cols="2">
<colspec colwidth="4*" colname="name"></colspec>
<literal>preferredRecordSyntax</literal> are ignored.
</para>
<para>
- Options <literal>start</literal> and <literal>count</literal>
+ Options <literal>start</literal> and <literal>count</literal>
are supported by SRU.
The remaining options
- <literal>piggyback</literal>,
- <literal>smallSetUpperBound</literal>,
- <literal>largeSetLowerBound</literal>,
- <literal>mediumSetPresentNumber</literal>,
+ <literal>piggyback</literal>,
+ <literal>smallSetUpperBound</literal>,
+ <literal>largeSetLowerBound</literal>,
+ <literal>mediumSetPresentNumber</literal>,
<literal>mediumSetElementSetName</literal>,
<literal>smallSetElementSetName</literal> are
unsupported.
SRU SearchRetrieveRequest.
</para>
<para>
- Unfortunately, SRU does not define a database setting. Hence,
+ SOLR queries has to be done in SOLR query format.
+ </para>
+ <para>
+ 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
+ However, the path part in host parameter for functions
<function>ZOOM_connecton_new</function> and
<function>ZOOM_connection_connect</function> acts as a
database (at least for the &yaz; SRU server).
void ZOOM_record_destroy(ZOOM_record rec);
</synopsis>
<para>
- References to temporary records are returned by functions
+ References to temporary records are returned by functions
<function>ZOOM_resultset_records</function> or
<function>ZOOM_resultset_record</function>.
</para>
</para>
<para>
A single record is returned by function
- <function>ZOOM_resultset_record</function> that takes a
+ <function>ZOOM_resultset_record</function> that takes a
position as argument. First record has position zero.
If no record could be obtained <literal>NULL</literal> is returned.
</para>
The <parameter>type</parameter> is a string of the format:
</para>
<para>
- <replaceable>form</replaceable>[;charset=<replaceable>from</replaceable>[,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
+ <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
</para>
<para>
- where <replaceable>form</replaceable> specifies the format of the
+ where <replaceable>format</replaceable> specifies the format of the
returned record, <replaceable>from</replaceable>
specifies the character set of the record in its original form
(as returned by the server), <replaceable>to</replaceable> specifies
the output (returned)
character set encoding.
- If charset is not given, then no character set conversion takes place.
If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
+ If charset is not given, then no character set conversion takes place.
+ </para>
+
+ <para>OPAC records may be returned in a different
+ set from the bibliographic MARC record. If this is this the case,
+ <replaceable>opacfrom</replaceable> should be set to the character set
+ of the OPAC record part.
</para>
+ <note>
+ <para>
+ Specifying the OPAC record character set requires YAZ 4.1.5 or later.
+ </para>
+ </note>
<para>
The format argument controls whether record data should be XML
pretty-printed (post process operation).
- It is enabled only if format value <replaceable>v</replaceable> is
+ It is enabled only if format value <replaceable>v</replaceable> is
<literal>1</literal> and the record content is XML well-formed.
</para>
<para>
In addition, for certain types, the length
<literal>len</literal> passed will be set to the size in bytes of
- the returned information.
+ the returned information.
</para>
<para>
The following are the supported values for <replaceable>form</replaceable>.
<varlistentry><term><literal>database</literal></term>
<listitem><para>Database of record is returned
as a C null-terminated string. Return type
- <literal>const char *</literal>.
+ <literal>const char *</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>syntax</literal></term>
as a C null-terminated string containing the symbolic name of
the record syntax, e.g. <literal>Usmarc</literal>. Return type
is
- <literal>const char *</literal>.
+ <literal>const char *</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>schema</literal></term>
<listitem><para>The schema of the record is returned
as a C null-terminated string. Return type is
- <literal>const char *</literal>.
+ <literal>const char *</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>render</literal></term>
<varlistentry><term><literal>raw</literal></term>
<listitem><para>The record is returned in the internal
YAZ specific format. For GRS-1, Explain, and others, the
- raw data is returned as type
+ raw data is returned as type
<literal>Z_External *</literal> which is just the type for
the member <literal>retrievalRecord</literal> in
type <literal>NamePlusRecord</literal>.
</varlistentry>
<varlistentry><term><literal>xml</literal></term>
<listitem><para>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
<ulink url="&url.marcxml;">
MARCXML
- </ulink>
+ </ulink>
(converted from ISO2709 to MARCXML by YAZ).
- OPAC records are also converted to XML and the
+ OPAC records are also converted to XML and the
bibliographic record is converted to MARCXML (when possible).
GRS-1 records are not supported for this form.
Upon completion, the XML buffer is returned
returned verbatim. MARC records are returned in
<link linkend="tools.turbomarc">
TurboMARC
- </link>
+ </link>
(converted from ISO2709 to TurboMARC by YAZ).
Upon completion, the XML buffer is returned
(type <literal>const char *</literal>) and length is stored in
<para>
Most
<ulink url="&url.marc21;">MARC21</ulink>
- records uses the
+ records uses the
<ulink url="&url.marc8;">MARC-8</ulink>
character set encoding.
An application that wishes to display in Latin-1 would use
</para>
</sect2>
<sect2 id="zoom.sru.record.behavior">
- <title>SRU Protocol behavior</title>
+ <title>SRU/SOLR Protocol behavior</title>
<para>
- 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.
</para>
</sect2>
</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.
+ </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);
+ 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);
+ </synopsis>
+ <para>
+ References to temporary structures are returned by all functions. They are only valid as long the Result set is valid.
+ <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>
+ <para id="zoom.resultset.get_facet_field">
+ A single Facet field is returned by function
+ <function>ZOOM_resultset_get_facet_field</function> or <function>ZOOM_resultset_get_facet_field_by_index</function> 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) <literal>NULL</literal> is returned.
+ </para>
+ <para id="zoom.resultset.facets">
+ An array of facets field can be returned by <function>ZOOM_resultset_facets</function>. The length of the array is
+ given by <function>ZOOM_resultset_facets_size</function>. The array is zero-based and last entry will be at
+ <function>ZOOM_resultset_facets_size(result_set)</function>-1.
+ </para>
+ <para id="zoom.resultset.facets_names">
+ It is possible to interate over facets by name, by calling <function>ZOOM_resultset_facets_names</function>.
+ This will return an const array of char * where each string can be used as parameter for
+ <function>ZOOM_resultset_get_facet_field</function>.
+ </para>
+ <para>
+ Function <function>ZOOM_facet_field_name</function> gets the request facet name from a returned facet field.
+ </para>
+ <para>
+ Function <function>ZOOM_facet_field_get_term</function> returns the idx'th term and term count for a facet field.
+ Idx must between 0 and <function>ZOOM_facet_field_term_count</function>-1, otherwise the returned reference will be
+ <literal>NULL</literal>. On a valid idx, the value of the freq reference will be the term count.
+ The *freq parameter must be valid pointer to integer.
+ </para>
+ </sect1>
<sect1 id="zoom.scan"><title>Scan</title>
<para>
This section describes an interface for Scan. Scan is not an
</para>
<para>
- The Scan interface is supported for both Z39.50 and SRU.
+ The Scan interface is supported for both Z39.50, SRU (and SOLR?).
</para>
<synopsis>
a scan set offset <literal>pos</literal> and returns a pointer
to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
non-present.
- If present, the <literal>occ</literal> and <literal>len</literal>
+ If present, the <literal>occ</literal> and <literal>len</literal>
are set to the number of occurrences and the length
of the actual term respectively.
<function>ZOOM_scanset_display_term</function> is similar to
more generic alternative to <function>ZOOM_connection_scan</function>
which allows to use both CQL and PQF for Scan.
</para>
-
+
<table frame="top" id="zoom.scanset.options">
<title>ZOOM Scan Set Options</title>
<tgroup cols="3">
</para>
<para>
<function>ZOOM_package_send</function> sends
- the package the via connection specified in
+ the package the via connection specified in
<function>ZOOM_connection_package</function>.
The <parameter>type</parameter> specifies the actual extended service
package type to be sent.
<row>
<entry>action</entry>
<entry>
- The update action. One of
+ The update action. One of
<literal>specialUpdate</literal>,
<literal>recordInsert</literal>,
<literal>recordReplace</literal>,
<literal>syntax</literal> (see below).
Option <literal>recordOpaque</literal> is an alternative
to record - and <literal>record</literal> option (above) is
- ignored if recordOpaque is set. This option is only available in
+ ignored if recordOpaque is set. This option is only available in
YAZ 3.0.35 and later and is meant to facilitate Updates with
servers from OCLC.
</entry>
1, 2 or 3. Each version has a distinct OID:
1.2.840.10003.9.5
(<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
- 1.2.840.10003.9.5.1
- (second version) and
- 1.2.840.10003.9.5.1.1
+ 1.2.840.10003.9.5.1
+ (second version) and
+ 1.2.840.10003.9.5.1.1
(<ulink url="&url.z39.50.extupdate3;">third and
newest version</ulink>).
</entry>
</tbody>
</tgroup>
</table>
-
+
</sect2>
<sect2 id="zoom.database.create"><title>Database Create</title>
For Database Create, type must be set to <literal>create</literal> in
<function>ZOOM_package_send</function>.
</para>
-
+
<table frame="top" id="zoom.database.create.options">
<title>Database Create Options</title>
<tgroup cols="3">
</tgroup>
</table>
</sect2>
-
+
<sect2 id="zoom.database.drop"><title>Database Drop</title>
<para>
For Database Drop, type must be set to <literal>drop</literal> in
<function>ZOOM_package_send</function>.
</para>
-
+
<table frame="top" id="zoom.database.drop.options">
<title>Database Drop Options</title>
<tgroup cols="3">
</tgroup>
</table>
</sect2>
-
+
<sect2 id="zoom.commit"><title>Commit Operation</title>
<para>
For Commit, type must be set to <literal>commit</literal> in
</sect1>
<sect1 id="zoom.events"><title>Events</title>
<para>
- If you're developing non-blocking applications, you have to deal
+ If you're developing non-blocking applications, you have to deal
with events.
</para>
<synopsis>
</table>
</sect1>
</chapter>
-
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-namecase-general:t
End:
-->
-
+
projects / yaz-moved-to-github.git / blobdiff