3 ZOOM_connection_errcode(c)
4 ZOOM_connection_errmsg(c)
5 ZOOM_connection_addinfo(c)
6 ZOOM_connection_addinfo(c)
7 ZOOM_connection_diagset(c);
8 ZOOM_connection_save_apdu_wrbuf
10 ZOOM_resultset_record_immediate(s, pos)
11 ZOOM_resultset_cache_reset(r)
12 ZOOM_options_set_callback(opt, function, handle)
13 ZOOM_options_create_with_parent2(parent1, parent2)
14 ZOOM_options_getl(opt, name, len)
15 ZOOM_options_setl(opt, name, value, len)
16 ZOOM_options_get_bool(opt, name, defa)
17 ZOOM_options_get_int(opt, name, defa)
18 ZOOM_options_set_int(opt, name, value)
20 <chapter id="zoom"><title>ZOOM</title>
22 &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
23 an initiative started by Mike Taylor (Mike is from the UK, which
24 explains the peculiar name of the model). The goal of &zoom; is to
25 provide a common Z39.50 client API not bound to a particular
26 programming language or toolkit.
30 From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
31 You can make SRU ZOOM connections by specifying scheme
32 <literal>http://</literal> for the hostname for a connection.
33 The dialect of SRU used is specified by the value of the
34 connection's <literal>sru</literal> option, which may be SRU over
35 HTTP GET (<literal>get</literal>),
36 SRU over HTTP POST (<literal>post</literal>), (SRU over
37 SOAP) (<literal>soap</literal>) or <literal>solr</literal>
38 (<ulink url="&url.solr;">Solr</ulink> Web Service).
39 Using the facility for embedding options in target strings, a
40 connection can be forced to use SRU rather the SRW (the default) by
41 prefixing the target string with <literal>sru=get,</literal>, like this:
42 <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
45 <ulink url="&url.solr;">Solr</ulink> protocol support was added to
46 YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
50 The lack of a simple Z39.50 client API for &yaz; has become more
51 and more apparent over time. So when the first &zoom; specification
53 an implementation for &yaz; was quickly developed. For the first time, it is
54 now as easy (or easier!) to develop clients than servers with &yaz;. This
55 chapter describes the &zoom; C binding. Before going further, please
56 reconsider whether C is the right programming language for the job.
57 There are other language bindings available for &yaz;, and still
59 are in active development. See the
60 <ulink url="&url.zoom;">ZOOM web-site</ulink> for
65 In order to fully understand this chapter you should read and
66 try the example programs <literal>zoomtst1.c</literal>,
67 <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
72 The C language misses features found in object oriented languages
73 such as C++, Java, etc. For example, you'll have to manually,
74 destroy all objects you create, even though you may think of them as
75 temporary. Most objects has a <literal>_create</literal> - and a
76 <literal>_destroy</literal> variant.
77 All objects are in fact pointers to internal stuff, but you don't see
78 that because of typedefs. All destroy methods should gracefully ignore a
79 <literal>NULL</literal> pointer.
82 In each of the sections below you'll find a sub section called
83 protocol behavior, that describes how the API maps to the Z39.50
86 <sect1 id="zoom-connections"><title>Connections</title>
88 <para>The Connection object is a session with a target.
91 #include <yaz/zoom.h>
93 ZOOM_connection ZOOM_connection_new(const char *host, int portnum);
95 ZOOM_connection ZOOM_connection_create(ZOOM_options options);
97 void ZOOM_connection_connect(ZOOM_connection c, const char *host,
99 void ZOOM_connection_destroy(ZOOM_connection c);
102 Connection objects are created with either function
103 <function>ZOOM_connection_new</function> or
104 <function>ZOOM_connection_create</function>.
105 The former creates and automatically attempts to establish a network
106 connection with the target. The latter doesn't establish
107 a connection immediately, thus allowing you to specify options
108 before establishing network connection using the function
109 <function>ZOOM_connection_connect</function>.
110 If the port number, <literal>portnum</literal>, is zero, the
111 <literal>host</literal> is consulted for a port specification.
112 If no port is given, 210 is used. A colon denotes the beginning of
113 a port number in the host string. If the host string includes a
114 slash, the following part specifies a database for the connection.
117 You can prefix the host with a scheme followed by colon. The
118 default scheme is <literal>tcp</literal> (Z39.50 protocol).
119 The scheme <literal>http</literal> selects SRU/get over HTTP by default,
120 but can overridded to use SRU/post, SRW and the Solr protocol.
123 You can prefix the scheme-qualified host-string with one or more
125 <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
126 sequences, each of which represents an option to be set into the
127 connection structure <emphasis>before</emphasis> the
128 protocol-level connection is forged and the initialization
129 handshake takes place. This facility can be used to provide
130 authentication credentials, as in host-strings such as:
131 <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
134 Connection objects should be destroyed using the function
135 <function>ZOOM_connection_destroy</function>.
138 void ZOOM_connection_option_set(ZOOM_connection c,
139 const char *key, const char *val);
141 void ZOOM_connection_option_setl(ZOOM_connection c,
143 const char *val, int len);
145 const char *ZOOM_connection_option_get(ZOOM_connection c,
147 const char *ZOOM_connection_option_getl(ZOOM_connection c,
152 The functions <function>ZOOM_connection_option_set</function> and
153 <function>ZOOM_connection_option_setl</function> allows you to
154 set an option given by <parameter>key</parameter> to the value
155 <parameter>value</parameter> for the connection.
156 For <function>ZOOM_connection_option_set</function>, the
157 value is assumed to be a 0-terminated string. Function
158 <function>ZOOM_connection_option_setl</function> specifies a
159 value of a certain size (len).
162 Functions <function>ZOOM_connection_option_get</function> and
163 <function>ZOOM_connection_option_getl</function> returns
164 the value for an option given by <parameter>key</parameter>.
166 <table id="zoom-connection-options" frame="top">
167 <title>ZOOM Connection Options</title>
169 <colspec colwidth="4*" colname="name"></colspec>
170 <colspec colwidth="7*" colname="description"></colspec>
171 <colspec colwidth="3*" colname="default"></colspec>
174 <entry>Option</entry>
175 <entry>Description</entry>
176 <entry>Default</entry>
181 implementationName</entry><entry>Name of Your client
182 </entry><entry>none</entry></row>
184 user</entry><entry>Authentication user name
185 </entry><entry>none</entry></row>
187 group</entry><entry>Authentication group name
188 </entry><entry>none</entry></row>
190 password</entry><entry>Authentication password.
191 </entry><entry>none</entry></row>
193 authenticationMode</entry><entry>How authentication is encoded.
194 </entry><entry>basic</entry></row>
196 host</entry><entry>Target host. This setting is "read-only".
197 It's automatically set internally when connecting to a target.
198 </entry><entry>none</entry></row>
200 proxy</entry><entry>Proxy host. If set, the logical host
201 is encoded in the otherInfo area of the Z39.50 Init PDU
202 with OID 1.2.840.10003.10.1000.81.1.
203 </entry><entry>none</entry></row>
205 clientIP</entry><entry>Client IP. If set, is
206 encoded in the otherInfo area of a Z39.50 PDU with OID
207 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
208 of a client. Is used of ZOOM is used in a gateway of some sort.
209 </entry><entry>none</entry></row>
211 async</entry><entry>If true (1) the connection operates in
212 asynchronous operation which means that all calls are non-blocking
214 <link linkend="zoom.events"><function>ZOOM_event</function></link>.
215 </entry><entry>0</entry></row>
217 maximumRecordSize</entry><entry> Maximum size of single record.
218 </entry><entry>1 MB</entry></row>
220 preferredMessageSize</entry><entry> Maximum size of multiple records.
221 </entry><entry>1 MB</entry></row>
223 lang</entry><entry> Language for negotiation.
224 </entry><entry>none</entry></row>
226 charset</entry><entry> Character set for negotiation.
227 </entry><entry>none</entry></row>
229 serverImplementationId</entry><entry>
230 Implementation ID of server. (The old targetImplementationId
231 option is also supported for the benefit of old applications.)
232 </entry><entry>none</entry></row>
234 targetImplementationName</entry><entry>
235 Implementation Name of server. (The old
236 targetImplementationName option is also supported for the
237 benefit of old applications.)
238 </entry><entry>none</entry></row>
240 serverImplementationVersion</entry><entry>
241 Implementation Version of server. (the old
242 targetImplementationVersion option is also supported for the
243 benefit of old applications.)
244 </entry><entry>none</entry></row>
246 databaseName</entry><entry>One or more database names
247 separated by character plus (<literal>+</literal>), which to
248 be used by subsequent search requests on this Connection.
249 </entry><entry>Default</entry></row>
251 piggyback</entry><entry>True (1) if piggyback should be
252 used in searches; false (0) if not.
253 </entry><entry>1</entry></row>
255 smallSetUpperBound</entry><entry>If hits is less than or equal to this
256 value, then target will return all records using small element set name
257 </entry><entry>0</entry></row>
259 largeSetLowerBound</entry><entry>If hits is greater than this
260 value, the target will return no records.
261 </entry><entry>1</entry></row>
263 mediumSetPresentNumber</entry><entry>This value represents
264 the number of records to be returned as part of a search when when
265 hits is less than or equal to large set lower bound and if hits
266 is greater than small set upper bound.
267 </entry><entry>0</entry></row>
269 smallSetElementSetName</entry><entry>
270 The element set name to be used for small result sets.
271 </entry><entry>none</entry></row>
273 mediumSetElementSetName</entry><entry>
274 The element set name to be for medium-sized result sets.
275 </entry><entry>none</entry></row>
277 init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
278 After a successful Init, these options may be interrogated to
279 discover whether the server claims to support the specified
281 </entry><entry>none</entry></row>
283 <entry>sru</entry><entry>
284 SRU/Solr transport type. Must be either <literal>soap</literal>,
285 <literal>get</literal>, <literal>post</literal>, or
286 <literal>solr</literal>.
287 </entry><entry>soap</entry></row>
289 sru_version</entry><entry>
290 SRU/SRW version. Should be <literal>1.1</literal>, or
291 <literal>1.2</literal>. This is , prior to connect, the version
292 to offer (highest version). And following connect (in fact
293 first operation), holds the negotiated version with the server
294 (same or lower version).
295 </entry><entry>1.2</entry></row>
297 facets</entry><entry>
298 A FacetList is comma-separated list of facet, which is defined
299 as <literal>AttributeList</literal> and a optional FacetTerm
300 (a Term and a frequency). On request the terms is missing.
301 On response the the list contains the terms that the target
303 </entry><entry>none</entry></row>
305 apdulog</entry><entry>
306 If set to a true value such as "1", a log of low-level
307 protocol packets is emitted on standard error stream. This
308 can be very useful for debugging.
309 </entry><entry>0</entry></row>
311 saveAPDU</entry><entry>
312 If set to a true value such as "1", a log of low-level
313 protocol packets is saved. The log can be retrieved by reading
314 option APDU. Setting saveAPDU always has the side effect of
315 resetting the currently saved log. This setting is
316 <emphasis>write-only</emphasis>. If read, NULL will be returned.
317 It is only recognized in
318 <function>ZOOM_connection_option_set</function>.
319 </entry><entry>0</entry></row>
322 Returns the log of protocol packets. Will be empty if logging
323 is not enabled (see saveAPDU above). This setting is
324 <emphasis>read-only</emphasis>. It is only recognized if used
325 in call to <function>ZOOM_connection_option_get</function> or
326 <function>ZOOM_connection_option_getl</function>.
327 </entry><entry></entry></row>
329 memcached</entry><entry>
330 If given and non-empty,
331 <ulink url="&url.libmemcached;">libMemcached</ulink>
332 will be configured for the connection.
333 This option is inspected by ZOOM when a connection is established.
334 If the <literal>memcached</literal> option is given
335 and YAZ is compiled without libMemcached support, an internal
336 diagnostic (10018) will be thrown.
337 libMemcached support is available for YAZ 5.0.13 or later. If this
338 option is supplied for an earlier version of YAZ, it is
339 <emphasis>ignored</emphasis>.
340 The value of this option is a string passed verbatim to
341 the <function>memcached</function> function part of libMemcached.
343 <ulink url="http://manned.org/memcached.3">memcached(3)</ulink>.
344 Earlier versions of libMemcached
345 do not offer this function. In this case only the option
346 <literal>--server=</literal><replaceable>host</replaceable> may
347 be given (YAZ emulates that part of libMemcached).
348 </entry><entry>none</entry></row>
353 If either option <literal>lang</literal> or <literal>charset</literal>
355 <ulink url="&url.z39.50.charneg;">
356 Character Set and Language Negotiation</ulink> is in effect.
359 int ZOOM_connection_error(ZOOM_connection c, const char **cp,
360 const char **addinfo);
361 int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
362 const char **addinfo, const char **dset);
365 Function <function>ZOOM_connection_error</function> checks for
366 errors for the last operation(s) performed. The function returns
367 zero if no errors occurred; non-zero otherwise indicating the error.
368 Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
369 holds messages for the error and additional-info if passed as
370 non-<literal>NULL</literal>. Function
371 <function>ZOOM_connection_error_x</function> is an extended version
372 of <function>ZOOM_connection_error</function> that is capable of
373 returning name of diagnostic set in <parameter>dset</parameter>.
375 <sect2 id="zoom-connection-z39.50">
376 <title>Z39.50 Protocol behavior</title>
378 The calls <function>ZOOM_connection_new</function> and
379 <function>ZOOM_connection_connect</function> establishes a TCP/IP
380 connection and sends an Initialize Request to the target if
381 possible. In addition, the calls waits for an Initialize Response
382 from the target and the result is inspected (OK or rejected).
385 If <literal>proxy</literal> is set then the client will establish
386 a TCP/IP connection with the peer as specified by the
387 <literal>proxy</literal> host and the hostname as part of the
388 connect calls will be set as part of the Initialize Request.
389 The proxy server will then "forward" the PDU's transparently
390 to the target behind the proxy.
393 For the authentication parameters, if option <literal>user</literal>
394 is set and both options <literal>group</literal> and
395 <literal>pass</literal> are unset, then Open style
396 authentication is used (Version 2/3) in which case the username
397 is usually followed by a slash, then by a password.
398 If either <literal>group</literal>
399 or <literal>pass</literal> is set then idPass authentication
400 (Version 3 only) is used. If none of the options are set, no
401 authentication parameters are set as part of the Initialize Request
405 When option <literal>async</literal> is 1, it really means that
406 all network operations are postponed (and queued) until the
407 function <literal>ZOOM_event</literal> is invoked. When doing so
408 it doesn't make sense to check for errors after
409 <literal>ZOOM_connection_new</literal> is called since that
410 operation "connecting - and init" is still incomplete and the
411 API cannot tell the outcome (yet).
414 <sect2 id="zoom.sru.init.behavior">
415 <title>SRU/Solr Protocol behavior</title>
417 The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
418 Inititialize Request, so the connection phase merely establishes a
419 TCP/IP connection with the HTTP server.
421 <para>Most of the ZOOM connection options do not
422 affect SRU/Solr and they are ignored. However, future versions
423 of &yaz; might honor <literal>implementationName</literal> and
424 put that as part of User-Agent header for HTTP requests.
427 The <literal>charset</literal> is used in the Content-Type header
431 Setting <literal>authentcationMode</literal> specifies how
432 authentication parameters are encoded for HTTP. The default is
433 "<literal>basic</literal>" where <literal>user</literal> and
434 <literal>password</literal> are encoded by using HTTP basic
438 If <literal>authentcationMode</literal> is "<literal>url</literal>", then
439 user and password are encoded in the URL by parameters
440 <literal>x-username</literal> and <literal>x-password</literal> as
441 given by the SRU standard.
445 <sect1 id="zoom.query"><title>Queries</title>
447 Query objects represents queries.
450 ZOOM_query ZOOM_query_create(void);
452 void ZOOM_query_destroy(ZOOM_query q);
454 int ZOOM_query_prefix(ZOOM_query q, const char *str);
456 int ZOOM_query_cql(ZOOM_query s, const char *str);
458 int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
460 int ZOOM_query_sortby2(ZOOM_query q, const char *strategy,
461 const char *criteria);
464 Create query objects using <function>ZOOM_query_create</function>
465 and destroy them by calling <function>ZOOM_query_destroy</function>.
466 RPN-queries can be specified in <link linkend="PQF">PQF</link>
467 notation by using the
468 function <function>ZOOM_query_prefix</function>.
469 The <function>ZOOM_query_cql</function> specifies a CQL
470 query to be sent to the server/target.
471 More query types will be added in future versions of &yaz;, such as
472 <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
473 etc. In addition to a search, a sort criteria may be set. Function
474 <function>ZOOM_query_sortby</function> enables Z39.50 sorting and
475 it takes sort criteria using the same string notation as
476 yaz-client's <link linkend="sortspec">sort command</link>.
478 <para id="zoom.query.sortby2">
479 <function>ZOOM_query_sortby2</function> is similar to
480 <function>ZOOM_query_sortby</function> but allows a strategy for
481 sorting. The reason for the strategy parameter is that some
482 protocols offers multiple ways of performing sorting.
483 For example, Z39.50 has the standard sort, which is performed after
484 search on an existing result set.
485 It's also possible to use CQL in Z39.50 as the query type and use
486 CQL's SORTBY keyword. Finally, Index Data's
487 Zebra server also allows sorting to be specified as part of RPN (Type 7).
489 <table id="zoom-sort-strategy" frame="top">
490 <title>ZOOM sort strategy</title>
492 <colspec colwidth="2*" colname="name"/>
493 <colspec colwidth="5*" colname="description"/>
497 <entry>Description</entry>
502 <entry>z39.50</entry><entry>Z39.50 resultset sort</entry>
505 <entry>type7</entry><entry>Sorting embedded in RPN(Type-7)</entry>
508 <entry>cql</entry><entry>CQL SORTBY</entry>
511 <entry>sru11</entry><entry>SRU sortKeys parameter</entry>
514 <entry>solr</entry><entry>Solr sort</entry>
517 <entry>embed</entry><entry>type7 for Z39.50, cql for SRU,
518 solr for Solr protocol</entry>
524 <sect1 id="zoom.resultsets"><title>Result sets</title>
526 The result set object is a container for records returned from
530 ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
532 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
534 void ZOOM_resultset_destroy(ZOOM_resultset r);
537 Function <function>ZOOM_connection_search</function> creates
538 a result set given a connection and query.
539 Destroy a result set by calling
540 <function>ZOOM_resultset_destroy</function>.
541 Simple clients may using PQF only may use function
542 <function>ZOOM_connection_search_pqf</function> in which case
543 creating query objects is not necessary.
546 void ZOOM_resultset_option_set(ZOOM_resultset r,
547 const char *key, const char *val);
549 const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
551 size_t ZOOM_resultset_size(ZOOM_resultset r);
554 Functions <function>ZOOM_resultset_options_set</function> and
555 <function>ZOOM_resultset_get</function> sets and gets an option
556 for a result set similar to <function>ZOOM_connection_option_get</function>
557 and <function>ZOOM_connection_option_set</function>.
560 The number of hits also called result-count is returned by
561 function <function>ZOOM_resultset_size</function>.
563 <table id="zoom.resultset.options"
564 frame="top"><title>ZOOM Result set Options</title>
566 <colspec colwidth="4*" colname="name"></colspec>
567 <colspec colwidth="7*" colname="description"></colspec>
568 <colspec colwidth="2*" colname="default"></colspec>
571 <entry>Option</entry>
572 <entry>Description</entry>
573 <entry>Default</entry>
578 start</entry><entry>Offset of first record to be
579 retrieved from target. First record has offset 0 unlike the
580 protocol specifications where first record has position 1.
581 This option affects ZOOM_resultset_search and
582 ZOOM_resultset_search_pqf and must be set before any of
583 these functions are invoked. If a range of
584 records must be fetched manually after search,
585 function ZOOM_resultset_records should be used.
586 </entry><entry>0</entry></row>
588 count</entry><entry>Number of records to be retrieved.
589 This option affects ZOOM_resultset_search and
590 ZOOM_resultset_search_pqf and must be set before any of
591 these functions are invoked.
592 </entry><entry>0</entry></row>
594 presentChunk</entry><entry>The number of records to be
595 requested from the server in each chunk (present request). The
596 value 0 means to request all the records in a single chunk.
597 (The old <literal>step</literal>
598 option is also supported for the benefit of old applications.)
599 </entry><entry>0</entry></row>
601 elementSetName</entry><entry>Element-Set name of records.
602 Most targets should honor element set name <literal>B</literal>
603 and <literal>F</literal> for brief and full respectively.
604 </entry><entry>none</entry></row>
606 preferredRecordSyntax</entry><entry>Preferred Syntax, such as
607 <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
608 </entry><entry>none</entry></row>
610 schema</entry><entry>Schema for retrieval, such as
611 <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
612 </entry><entry>none</entry></row>
614 setname</entry><entry>Name of Result Set (Result Set ID).
615 If this option isn't set, the ZOOM module will automatically
616 allocate a result set name.
617 </entry><entry>default</entry></row>
619 rpnCharset</entry><entry>Character set for RPN terms.
620 If this is set, ZOOM C will assume that the ZOOM application is
621 running UTF-8. Terms in RPN queries are then converted to the
622 rpnCharset. If this is unset, ZOOM C will not assume any encoding
623 of RPN terms and no conversion is performed.
624 </entry><entry>none</entry></row>
629 For servers that support Search Info report, the following
630 options may be read using <function>ZOOM_resultset_get</function>.
631 This detailed information is read after a successful search has
635 This information is a list of of items, where each item is
636 information about a term or subquery. All items in the list
638 <literal>SearchResult.</literal><replaceable>no</replaceable>
639 where no presents the item number (0=first, 1=second).
640 Read <literal>searchresult.size</literal> to determine the
643 <table id="zoom.search.info.report.options"
644 frame="top"><title>Search Info Report Options</title>
646 <colspec colwidth="4*" colname="name"></colspec>
647 <colspec colwidth="7*" colname="description"></colspec>
650 <entry>Option</entry>
651 <entry>Description</entry>
656 <entry>searchresult.size</entry>
658 number of search result entries. This option is-nonexistant
659 if no entries are returned by the server.
663 <entry>searchresult.<replaceable>no</replaceable>.id</entry>
664 <entry>sub query ID</entry>
667 <entry>searchresult.<replaceable>no</replaceable>.count</entry>
668 <entry>result count for item (number of hits)</entry>
671 <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
672 <entry>subquery term</entry>
676 searchresult.<replaceable>no</replaceable>.interpretation.term
678 <entry>interpretation term</entry>
682 searchresult.<replaceable>no</replaceable>.recommendation.term
684 <entry>recommendation term</entry>
690 <sect2 id="zoom.z3950.resultset.sort">
691 <title>Z39.50 Result-set Sort</title>
693 void ZOOM_resultset_sort(ZOOM_resultset r,
694 const char *sort_type, const char *sort_spec);
696 int ZOOM_resultset_sort1(ZOOM_resultset r,
697 const char *sort_type, const char *sort_spec);
700 <function>ZOOM_resultset_sort</function> and
701 <function>ZOOM_resultset_sort1</function> both sort an existing
702 result-set. The sort_type parameter is not use. Set it to "yaz".
703 The sort_spec is same notation as ZOOM_query_sortby and identical
704 to that offered by yaz-client's
705 <link linkend="sortspec">sort command</link>.
708 These functions only work for Z39.50. Use the more generic utility
709 <link linkend="zoom.query.sortby2">
710 <function>ZOOM_query_sortby2</function></link>
711 for other protocols (and even Z39.50).
714 <sect2 id="zoom.z3950.resultset.behavior">
715 <title>Z39.50 Protocol behavior</title>
717 The creation of a result set involves at least a SearchRequest
718 - SearchResponse protocol handshake. Following that, if a sort
719 criteria was specified as part of the query, a SortRequest -
720 SortResponse handshake takes place. Note that it is necessary to
721 perform sorting before any retrieval takes place, so no records will
722 be returned from the target as part of the SearchResponse because these
723 would be unsorted. Hence, piggyback is disabled when sort criteria
724 are set. Following Search - and a possible sort - Retrieval takes
725 place - as one or more Present Requests/Response pairs being
729 The API allows for two different modes for retrieval. A high level
730 mode which is somewhat more powerful and a low level one.
731 The low level is enabled when searching on a Connection object
732 for which the settings
733 <literal>smallSetUpperBound</literal>,
734 <literal>mediumSetPresentNumber</literal> and
735 <literal>largeSetLowerBound</literal> are set. The low level mode
736 thus allows you to precisely set how records are returned as part
737 of a search response as offered by the Z39.50 protocol.
738 Since the client may be retrieving records as part of the
739 search response, this mode doesn't work well if sorting is used.
742 The high-level mode allows you to fetch a range of records from
743 the result set with a given start offset. When you use this mode
744 the client will automatically use piggyback if that is possible
745 with the target and perform one or more present requests as needed.
746 Even if the target returns fewer records as part of a present response
747 because of a record size limit, etc. the client will repeat sending
748 present requests. As an example, if option <literal>start</literal>
749 is 0 (default) and <literal>count</literal> is 4, and
750 <literal>piggyback</literal> is 1 (default) and no sorting criteria
751 is specified, then the client will attempt to retrieve the 4
752 records as part the search response (using piggyback). On the other
753 hand, if either <literal>start</literal> is positive or if
754 a sorting criteria is set, or if <literal>piggyback</literal>
755 is 0, then the client will not perform piggyback but send Present
759 If either of the options <literal>mediumSetElementSetName</literal> and
760 <literal>smallSetElementSetName</literal> are unset, the value
761 of option <literal>elementSetName</literal> is used for piggyback
762 searches. This means that for the high-level mode you only have
763 to specify one elementSetName option rather than three.
766 <sect2 id="zoom.sru.resultset.behavior">
767 <title>SRU Protocol behavior</title>
769 Current version of &yaz; does not take advantage of a result set id
770 returned by the SRU server. Future versions might do, however.
771 Since, the ZOOM driver does not save result set IDs any
772 present (retrieval) is transformed to a SRU SearchRetrieveRequest
773 with same query but, possibly, different offsets.
776 Option <literal>schema</literal> specifies SRU schema
777 for retrieval. However, options <literal>elementSetName</literal> and
778 <literal>preferredRecordSyntax</literal> are ignored.
781 Options <literal>start</literal> and <literal>count</literal>
782 are supported by SRU.
783 The remaining options
784 <literal>piggyback</literal>,
785 <literal>smallSetUpperBound</literal>,
786 <literal>largeSetLowerBound</literal>,
787 <literal>mediumSetPresentNumber</literal>,
788 <literal>mediumSetElementSetName</literal>,
789 <literal>smallSetElementSetName</literal> are
793 SRU supports CQL queries, <emphasis>not</emphasis> PQF.
794 If PQF is used, however, the PQF query is transferred anyway
795 using non-standard element <literal>pQuery</literal> in
796 SRU SearchRetrieveRequest.
799 Solr queries has to be done in Solr query format.
802 Unfortunately, SRU or Solr does not define a database setting. Hence,
803 <literal>databaseName</literal> is unsupported and ignored.
804 However, the path part in host parameter for functions
805 <function>ZOOM_connecton_new</function> and
806 <function>ZOOM_connection_connect</function> acts as a
807 database (at least for the &yaz; SRU server).
811 <sect1 id="zoom.records"><title>Records</title>
813 A record object is a retrieval record on the client side -
814 created from result sets.
817 void ZOOM_resultset_records(ZOOM_resultset r,
819 size_t start, size_t count);
820 ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
822 const char *ZOOM_record_get(ZOOM_record rec, const char *type,
825 int ZOOM_record_error(ZOOM_record rec, const char **msg,
826 const char **addinfo, const char **diagset);
828 ZOOM_record ZOOM_record_clone(ZOOM_record rec);
830 void ZOOM_record_destroy(ZOOM_record rec);
833 References to temporary records are returned by functions
834 <function>ZOOM_resultset_records</function> or
835 <function>ZOOM_resultset_record</function>.
838 If a persistent reference to a record is desired
839 <function>ZOOM_record_clone</function> should be used.
840 It returns a record reference that should be destroyed
841 by a call to <function>ZOOM_record_destroy</function>.
844 A single record is returned by function
845 <function>ZOOM_resultset_record</function> that takes a
846 position as argument. First record has position zero.
847 If no record could be obtained <literal>NULL</literal> is returned.
850 Error information for a record can be checked with
851 <function>ZOOM_record_error</function> which returns non-zero
852 (error code) if record is in error, called <emphasis>Surrogate
853 Diagnostics</emphasis> in Z39.50.
856 Function <function>ZOOM_resultset_records</function> retrieves
857 a number of records from a result set. Parameter <literal>start</literal>
858 and <literal>count</literal> specifies the range of records to
859 be returned. Upon completion array
860 <literal>recs[0], ..recs[count-1]</literal>
861 holds record objects for the records. The array of records
862 <literal>recs</literal> should be allocated prior the call
863 <function>ZOOM_resultset_records</function>. Note that for those
864 records that couldn't be retrieved from the target
865 <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
867 <para id="zoom.record.get">
868 In order to extract information about a single record,
869 <function>ZOOM_record_get</function> is provided. The
870 function returns a pointer to certain record information. The
871 nature (type) of the pointer depends on the parameter,
872 <parameter>type</parameter>.
875 The <parameter>type</parameter> is a string of the format:
878 <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>]
881 where <replaceable>format</replaceable> specifies the format of the
882 returned record, <replaceable>from</replaceable>
883 specifies the character set of the record in its original form
884 (as returned by the server), <replaceable>to</replaceable> specifies
885 the output (returned)
886 character set encoding.
887 If <replaceable>to</replaceable> is omitted UTF-8 is assumed.
888 If charset is not given, then no character set conversion takes place.
891 <para>OPAC records may be returned in a different
892 set from the bibliographic MARC record. If this is this the case,
893 <replaceable>opacfrom</replaceable> should be set to the character set
894 of the OPAC record part.
898 Specifying the OPAC record character set requires YAZ 4.1.5 or later.
902 The format argument controls whether record data should be XML
903 pretty-printed (post process operation).
904 It is enabled only if format value <replaceable>v</replaceable> is
905 <literal>1</literal> and the record content is XML well-formed.
908 In addition, for certain types, the length
909 <literal>len</literal> passed will be set to the size in bytes of
910 the returned information.
913 The following are the supported values for <replaceable>form</replaceable>.
915 <varlistentry><term><literal>database</literal></term>
916 <listitem><para>Database of record is returned
917 as a C null-terminated string. Return type
918 <literal>const char *</literal>.
921 <varlistentry><term><literal>syntax</literal></term>
922 <listitem><para>The transfer syntax of the record is returned
923 as a C null-terminated string containing the symbolic name of
924 the record syntax, e.g. <literal>Usmarc</literal>. Return type
926 <literal>const char *</literal>.
929 <varlistentry><term><literal>schema</literal></term>
930 <listitem><para>The schema of the record is returned
931 as a C null-terminated string. Return type is
932 <literal>const char *</literal>.
935 <varlistentry><term><literal>render</literal></term>
936 <listitem><para>The record is returned in a display friendly
937 format. Upon completion buffer is returned
938 (type <literal>const char *</literal>) and length is stored in
939 <literal>*len</literal>.
942 <varlistentry><term><literal>raw</literal></term>
943 <listitem><para>The record is returned in the internal
944 YAZ specific format. For GRS-1, Explain, and others, the
945 raw data is returned as type
946 <literal>Z_External *</literal> which is just the type for
947 the member <literal>retrievalRecord</literal> in
948 type <literal>NamePlusRecord</literal>.
949 For SUTRS and octet aligned record (including all MARCs) the
950 octet buffer is returned and the length of the buffer.
953 <varlistentry><term><literal>xml</literal></term>
954 <listitem><para>The record is returned in XML if possible.
955 SRU, Solr and Z39.50 records with transfer syntax XML are
956 returned verbatim. MARC records are returned in
957 <ulink url="&url.marcxml;">
960 (converted from ISO2709 to MARCXML by YAZ).
961 OPAC records are also converted to XML and the
962 bibliographic record is converted to MARCXML (when possible).
963 GRS-1 records are not supported for this form.
964 Upon completion, the XML buffer is returned
965 (type <literal>const char *</literal>) and length is stored in
966 <literal>*len</literal>.
969 <varlistentry><term><literal>opac</literal></term>
970 <listitem><para>OPAC information for record is returned in XML
971 if an OPAC record is present at the position given. If no
972 OPAC record is present, a NULL pointer is returned.
975 <varlistentry><term><literal>txml</literal></term>
976 <listitem><para>The record is returned in TurboMARC if possible.
977 SRU and Z39.50 records with transfer syntax XML are
978 returned verbatim. MARC records are returned in
979 <link linkend="tools.turbomarc">
982 (converted from ISO2709 to TurboMARC by YAZ).
983 Upon completion, the XML buffer is returned
984 (type <literal>const char *</literal>) and length is stored in
985 <literal>*len</literal>.
988 <varlistentry><term><literal>json</literal></term>
989 <listitem><para>Like xml, but MARC records are converted to
990 <ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>.
998 <ulink url="&url.marc21;">MARC21</ulink>
1000 <ulink url="&url.marc8;">MARC-8</ulink>
1001 character set encoding.
1002 An application that wishes to display in Latin-1 would use
1004 render; charset=marc8,iso-8859-1
1007 <sect2 id="zoom.z3950.record.behavior">
1008 <title>Z39.50 Protocol behavior</title>
1010 The functions <function>ZOOM_resultset_record</function> and
1011 <function>ZOOM_resultset_records</function> inspects the client-side
1012 record cache. Records not found in cache are fetched using
1014 The functions may block (and perform network I/O) - even though option
1015 <literal>async</literal> is 1, because they return records objects.
1016 (and there's no way to return records objects without retrieving them!).
1019 There is a trick, however, in the usage of function
1020 <function>ZOOM_resultset_records</function> that allows for
1021 delayed retrieval (and makes it non-blocking). By using
1022 a null pointer for <parameter>recs</parameter> you're indicating
1023 you're not interested in getting records objects
1024 <emphasis>now</emphasis>.
1027 <sect2 id="zoom.sru.record.behavior">
1028 <title>SRU/Solr Protocol behavior</title>
1030 The ZOOM driver for SRU/Solr treats records returned by a SRU/Solr server
1031 as if they where Z39.50 records with transfer syntax XML and
1032 no element set name or database name.
1036 <sect1 id="zoom.facets"><title>Facets</title>
1038 Facets operations is not part of the official ZOOM specification, but
1039 is an Index Data extension for YAZ-based Z39.50 targets or
1040 <ulink url="&url.solr;">Solr</ulink> targets.
1041 In case the target can and is requested to return facets, using a
1042 result set the ZOOM client can request one or all facet fields.
1043 Using a facet field the client can request the term count and then
1044 interate over the terms.
1047 ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
1049 const char ** ZOOM_resultset_facets_names(ZOOM_resultset r);
1051 ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r,
1052 const char *facet_name);
1054 ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r,
1057 size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
1059 const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
1061 size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
1063 const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field,
1064 size_t idx, int *freq);
1067 References to temporary structures are returned by all functions.
1068 They are only valid as long the Result set is valid.
1069 <function>ZOOM_resultset_get_facet_field</function> or
1070 <function>ZOOM_resultset_get_facet_field_by_index</function>.
1071 <function>ZOOM_resultset_facets</function>.
1072 <function>ZOOM_resultset_facets_names</function>.
1073 <function>ZOOM_facet_field_name</function>.
1074 <function>ZOOM_facet_field_get_term</function>.
1076 <para id="zoom.resultset.get_facet_field">
1077 A single Facet field is returned by function
1078 <function>ZOOM_resultset_get_facet_field</function> or
1079 <function>ZOOM_resultset_get_facet_field_by_index</function> that takes
1080 a result set and facet name or positive index respectively. First
1081 facet has position zero. If no facet could be obtained (invalid name
1082 or index out of bounds) <literal>NULL</literal> is returned.
1084 <para id="zoom.resultset.facets">
1085 An array of facets field can be returned by
1086 <function>ZOOM_resultset_facets</function>. The length of the array is
1087 given by <function>ZOOM_resultset_facets_size</function>. The array is
1088 zero-based and last entry will be at
1089 <function>ZOOM_resultset_facets_size(result_set)</function>-1.
1091 <para id="zoom.resultset.facets_names">
1092 It is possible to interate over facets by name, by calling
1093 <function>ZOOM_resultset_facets_names</function>.
1094 This will return an const array of char * where each string can be used
1095 as parameter for <function>ZOOM_resultset_get_facet_field</function>.
1098 Function <function>ZOOM_facet_field_name</function> gets the request
1099 facet name from a returned facet field.
1102 Function <function>ZOOM_facet_field_get_term</function> returns the
1103 idx'th term and term count for a facet field.
1104 Idx must between 0 and
1105 <function>ZOOM_facet_field_term_count</function>-1, otherwise the
1106 returned reference will be <literal>NULL</literal>. On a valid idx, the
1107 value of the freq reference will be the term count.
1108 The <literal>freq</literal> parameter must be valid pointer to integer.
1111 <sect1 id="zoom.scan"><title>Scan</title>
1113 This section describes an interface for Scan. Scan is not an
1114 official part of the ZOOM model yet. The result of a scan operation
1115 is the <literal>ZOOM_scanset</literal> which is a set of terms
1116 returned by a target.
1120 The Scan interface is supported for both Z39.50, SRU and Solr.
1124 ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
1125 const char *startpqf);
1127 ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
1130 size_t ZOOM_scanset_size(ZOOM_scanset scan);
1132 const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
1133 size_t *occ, size_t *len);
1135 const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
1136 size_t *occ, size_t *len);
1138 void ZOOM_scanset_destroy(ZOOM_scanset scan);
1140 const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
1143 void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
1147 The scan set is created by function
1148 <function>ZOOM_connection_scan</function> which performs a scan
1149 operation on the connection using the specified
1150 <parameter>startpqf</parameter>.
1151 If the operation was successful, the size of the scan set can be
1152 retrieved by a call to <function>ZOOM_scanset_size</function>.
1153 Like result sets, the items are numbered 0,..size-1.
1154 To obtain information about a particular scan term, call function
1155 <function>ZOOM_scanset_term</function>. This function takes
1156 a scan set offset <literal>pos</literal> and returns a pointer
1157 to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
1159 If present, the <literal>occ</literal> and <literal>len</literal>
1160 are set to the number of occurrences and the length
1161 of the actual term respectively.
1162 <function>ZOOM_scanset_display_term</function> is similar to
1163 <function>ZOOM_scanset_term</function> except that it returns
1164 the <emphasis>display term</emphasis> rather than the raw term.
1165 In a few cases, the term is different from display term. Always
1166 use the display term for display and the raw term for subsequent
1167 scan operations (to get more terms, next scan result, etc).
1170 A scan set may be freed by a call to function
1171 <function>ZOOM_scanset_destroy</function>.
1172 Functions <function>ZOOM_scanset_option_get</function> and
1173 <function>ZOOM_scanset_option_set</function> retrieves and sets
1174 an option respectively.
1178 The <parameter>startpqf</parameter> is a subset of PQF, namely
1179 the Attributes+Term part. Multiple <literal>@attr</literal> can
1180 be used. For example to scan in title (complete) phrases:
1182 @attr 1=4 @attr 6=2 "science o"
1187 The <function>ZOOM_connecton_scan1</function> is a newer and
1188 more generic alternative to <function>ZOOM_connection_scan</function>
1189 which allows to use both CQL and PQF for Scan.
1192 <table frame="top" id="zoom.scanset.options">
1193 <title>ZOOM Scan Set Options</title>
1195 <colspec colwidth="4*" colname="name"></colspec>
1196 <colspec colwidth="7*" colname="description"></colspec>
1197 <colspec colwidth="2*" colname="default"></colspec>
1200 <entry>Option</entry>
1201 <entry>Description</entry>
1202 <entry>Default</entry>
1207 number</entry><entry>Number of Scan Terms requested in next scan.
1208 After scan it holds the actual number of terms returned.
1209 </entry><entry>20</entry></row>
1211 position</entry><entry>Preferred Position of term in response
1212 in next scan; actual position after completion of scan.
1213 </entry><entry>1</entry></row>
1215 stepSize</entry><entry>Step Size
1216 </entry><entry>0</entry></row>
1218 scanStatus</entry><entry>An integer indicating the Scan Status
1220 </entry><entry>0</entry></row>
1222 rpnCharset</entry><entry>Character set for RPN terms.
1223 If this is set, ZOOM C will assume that the ZOOM application is
1224 running UTF-8. Terms in RPN queries are then converted to the
1225 rpnCharset. If this is unset, ZOOM C will not assume any encoding
1226 of RPN terms and no conversion is performed.
1227 </entry><entry>none</entry></row>
1233 <sect1 id="zoom.extendedservices"><title>Extended Services</title>
1235 ZOOM offers an interface to a subset of the Z39.50 extended services
1236 as well as a few privately defined ones:
1241 Z39.50 Item Order (ILL).
1242 See <xref linkend="zoom.item.order"/>.
1247 Record Update. This allows a client to insert, modify or delete
1249 See <xref linkend="zoom.record.update"/>.
1254 Database Create. This a non-standard feature. Allows a client
1255 to create a database.
1256 See <xref linkend="zoom.database.create"/>.
1261 Database Drop. This a non-standard feature. Allows a client
1262 to delete/drop a database.
1263 See <xref linkend="zoom.database.drop"/>.
1268 Commit operation. This a non-standard feature. Allows a client
1269 to commit operations.
1270 See <xref linkend="zoom.commit"/>.
1273 <!-- all the ILL PDU options should go here too -->
1276 To create an extended service operation a <literal>ZOOM_package</literal>
1277 must be created. The operation is a five step operation. The
1278 package is created, package is configured by means of options,
1279 the package is send, result is inspected (by means of options),
1280 the package is destroyed.
1283 ZOOM_package ZOOM_connection_package(ZOOM_connection c,
1284 ZOOM_options options);
1286 const char *ZOOM_package_option_get(ZOOM_package p,
1288 void ZOOM_package_option_set(ZOOM_package p, const char *key,
1290 void ZOOM_package_send(ZOOM_package p, const char *type);
1292 void ZOOM_package_destroy(ZOOM_package p);
1295 The <function>ZOOM_connection_package</function> creates a
1296 package for the connection given using the options specified.
1299 Functions <function>ZOOM_package_option_get</function> and
1300 <function>ZOOM_package_option_set</function> gets and sets
1304 <function>ZOOM_package_send</function> sends
1305 the package the via connection specified in
1306 <function>ZOOM_connection_package</function>.
1307 The <parameter>type</parameter> specifies the actual extended service
1308 package type to be sent.
1311 <table frame="top" id="zoom.extendedservices.options">
1312 <title>Extended Service Common Options</title>
1314 <colspec colwidth="4*" colname="name"></colspec>
1315 <colspec colwidth="7*" colname="description"></colspec>
1316 <colspec colwidth="3*" colname="default"></colspec>
1319 <entry>Option</entry>
1320 <entry>Description</entry>
1321 <entry>Default</entry>
1326 <entry>package-name</entry>
1327 <entry>Extended Service Request package name. Must be specified
1328 as part of a request</entry>
1332 <entry>user-id</entry>
1333 <entry>User ID of Extended Service Package. Is a request option</entry>
1337 <entry>function</entry>
1339 Function of package - one of <literal>create</literal>,
1340 <literal>delete</literal>, <literal>modify</literal>. Is
1343 <entry><literal>create</literal></entry>
1346 <entry>waitAction</entry>
1348 Wait action for package. Possible values:
1349 <literal>wait</literal>, <literal>waitIfPossible</literal>,
1350 <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
1352 <entry><literal>waitIfPossible</literal></entry>
1355 <entry>targetReference</entry>
1357 Target Reference. This is part of the response as returned
1358 by the server. Read it after a successful operation.
1360 <entry><literal>none</literal></entry>
1366 <sect2 id="zoom.item.order"><title>Item Order</title>
1368 For Item Order, type must be set to <literal>itemorder</literal> in
1369 <function>ZOOM_package_send</function>.
1372 <table frame="top" id="zoom.item.order.options">
1373 <title>Item Order Options</title>
1375 <colspec colwidth="4*" colname="name"></colspec>
1376 <colspec colwidth="7*" colname="description"></colspec>
1377 <colspec colwidth="3*" colname="default"></colspec>
1380 <entry>Option</entry>
1381 <entry>Description</entry>
1382 <entry>Default</entry>
1387 <entry>contact-name</entry>
1388 <entry>ILL contact name</entry>
1392 <entry>contact-phone</entry>
1393 <entry>ILL contact phone</entry>
1397 <entry>contact-email</entry>
1398 <entry>ILL contact email</entry>
1402 <entry>itemorder-item</entry>
1403 <entry>Position for item (record) requested. An integer</entry>
1412 <sect2 id="zoom.record.update"><title>Record Update</title>
1414 For Record Update, type must be set to <literal>update</literal> in
1415 <function>ZOOM_package_send</function>.
1418 <table frame="top" id="zoom.record.update.options">
1419 <title>Record Update Options</title>
1421 <colspec colwidth="4*" colname="name"></colspec>
1422 <colspec colwidth="7*" colname="description"></colspec>
1423 <colspec colwidth="3*" colname="default"></colspec>
1426 <entry>Option</entry>
1427 <entry>Description</entry>
1428 <entry>Default</entry>
1433 <entry>action</entry>
1435 The update action. One of
1436 <literal>specialUpdate</literal>,
1437 <literal>recordInsert</literal>,
1438 <literal>recordReplace</literal>,
1439 <literal>recordDelete</literal>,
1440 <literal>elementUpdate</literal>.
1442 <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
1445 <entry>recordIdOpaque</entry>
1446 <entry>Opaque Record ID</entry>
1450 <entry>recordIdNumber</entry>
1451 <entry>Record ID number</entry>
1455 <entry>record</entry>
1456 <entry>The record itself</entry>
1460 <entry>recordOpaque</entry>
1461 <entry>Specifies an opaque record which is
1462 encoded as an ASN.1 ANY type with the OID as tiven by option
1463 <literal>syntax</literal> (see below).
1464 Option <literal>recordOpaque</literal> is an alternative
1465 to record - and <literal>record</literal> option (above) is
1466 ignored if recordOpaque is set. This option is only available in
1467 YAZ 3.0.35 and later and is meant to facilitate Updates with
1473 <entry>syntax</entry>
1474 <entry>The record syntax (transfer syntax). Is a string that
1475 is a known record syntax.
1477 <entry>no syntax</entry>
1480 <entry>databaseName</entry>
1481 <entry>Database from connection object</entry>
1482 <entry>Default</entry>
1485 <entry>correlationInfo.note</entry>
1486 <entry>Correlation Info Note (string)</entry>
1490 <entry>correlationInfo.id</entry>
1491 <entry>Correlation Info ID (integer)</entry>
1495 <entry>elementSetName</entry>
1496 <entry>Element Set for Record</entry>
1500 <entry>updateVersion</entry>
1501 <entry>Record Update version which holds one of the values
1502 1, 2 or 3. Each version has a distinct OID:
1504 (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
1506 (second version) and
1507 1.2.840.10003.9.5.1.1
1508 (<ulink url="&url.z39.50.extupdate3;">third and
1509 newest version</ulink>).
1519 <sect2 id="zoom.database.create"><title>Database Create</title>
1521 For Database Create, type must be set to <literal>create</literal> in
1522 <function>ZOOM_package_send</function>.
1525 <table frame="top" id="zoom.database.create.options">
1526 <title>Database Create Options</title>
1528 <colspec colwidth="4*" colname="name"></colspec>
1529 <colspec colwidth="7*" colname="description"></colspec>
1530 <colspec colwidth="3*" colname="default"></colspec>
1533 <entry>Option</entry>
1534 <entry>Description</entry>
1535 <entry>Default</entry>
1540 <entry>databaseName</entry>
1541 <entry>Database from connection object</entry>
1542 <entry>Default</entry>
1549 <sect2 id="zoom.database.drop"><title>Database Drop</title>
1551 For Database Drop, type must be set to <literal>drop</literal> in
1552 <function>ZOOM_package_send</function>.
1555 <table frame="top" id="zoom.database.drop.options">
1556 <title>Database Drop Options</title>
1558 <colspec colwidth="4*" colname="name"></colspec>
1559 <colspec colwidth="7*" colname="description"></colspec>
1560 <colspec colwidth="3*" colname="default"></colspec>
1563 <entry>Option</entry>
1564 <entry>Description</entry>
1565 <entry>Default</entry>
1570 <entry>databaseName</entry>
1571 <entry>Database from connection object</entry>
1572 <entry>Default</entry>
1579 <sect2 id="zoom.commit"><title>Commit Operation</title>
1581 For Commit, type must be set to <literal>commit</literal> in
1582 <function>ZOOM_package_send</function>.
1586 <sect2 id="zoom.extended.services.behavior">
1587 <title>Protocol behavior</title>
1589 All the extended services are Z39.50-only.
1593 The database create, drop and commit services are privately defined
1595 Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
1602 <sect1 id="zoom.options"><title>Options</title>
1604 Most &zoom; objects provide a way to specify options to change behavior.
1605 From an implementation point of view a set of options is just like
1606 an associative array / hash.
1609 ZOOM_options ZOOM_options_create(void);
1611 ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
1613 void ZOOM_options_destroy(ZOOM_options opt);
1616 const char *ZOOM_options_get(ZOOM_options opt, const char *name);
1618 void ZOOM_options_set(ZOOM_options opt, const char *name,
1622 typedef const char *(*ZOOM_options_callback)
1623 (void *handle, const char *name);
1625 ZOOM_options_callback
1626 ZOOM_options_set_callback(ZOOM_options opt,
1627 ZOOM_options_callback c,
1632 <sect1 id="zoom.queryconversions"><title>Query conversions</title>
1634 int ZOOM_query_cql2rpn(ZOOM_query s, const char *cql_str,
1635 ZOOM_connection conn);
1637 int ZOOM_query_ccl2rpn(ZOOM_query s, const char *ccl_str,
1639 int *ccl_error, const char **error_string,
1643 <function>ZOOM_query_cql2rpn</function> translates the CQL string,
1644 client-side, into RPN which may be passed to the server.
1645 This is useful for server's that don't themselves
1646 support CQL, for which <function>ZOOM_query_cql</function> is useless.
1647 `conn' is used only as a place to stash diagnostics if compilation
1648 fails; if this information is not needed, a null pointer may be used.
1649 The CQL conversion is driven by option <literal>cqlfile</literal> from
1650 connection conn. This specifies a conversion file (eg pqf.properties)
1651 which <emphasis>must</emphasis> be present.
1654 <function>ZOOM_query_ccl2rpn</function> translates the CCL string,
1655 client-side, into RPN which may be passed to the server.
1656 The conversion is driven by the specification given by
1657 <literal>config</literal>. Upon completion 0 is returned on success; -1
1658 is returned on on failure. Om failure <literal>error_string</literal> and
1659 <literal>error_pos</literal> holds error message and position of
1660 first error in original CCL string.
1663 <sect1 id="zoom.events"><title>Events</title>
1665 If you're developing non-blocking applications, you have to deal
1669 int ZOOM_event(int no, ZOOM_connection *cs);
1672 The <function>ZOOM_event</function> executes pending events for
1673 a number of connections. Supply the number of connections in
1674 <literal>no</literal> and an array of connections in
1675 <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
1676 A pending event could be a sending a search, receiving a response,
1678 When an event has occurred for one of the connections, this function
1679 returns a positive integer <literal>n</literal> denoting that an event
1680 occurred for connection <literal>cs[n-1]</literal>.
1681 When no events are pending for the connections, a value of zero is
1683 To ensure that all outstanding requests are performed call this function
1684 repeatedly until zero is returned.
1687 If <function>ZOOM_event</function> returns and returns non-zero, the
1688 last event that occurred can be expected.
1691 int ZOOM_connection_last_event(ZOOM_connection cs);
1694 <function>ZOOM_connection_last_event</function> returns an event type
1695 (integer) for the last event.
1698 <table frame="top" id="zoom.event.ids">
1699 <title>ZOOM Event IDs</title>
1701 <colspec colwidth="4*" colname="name"></colspec>
1702 <colspec colwidth="7*" colname="description"></colspec>
1705 <entry>Event</entry>
1706 <entry>Description</entry>
1711 <entry>ZOOM_EVENT_NONE</entry>
1712 <entry>No event has occurred</entry>
1715 <entry>ZOOM_EVENT_CONNECT</entry>
1716 <entry>TCP/IP connect has initiated</entry>
1719 <entry>ZOOM_EVENT_SEND_DATA</entry>
1720 <entry>Data has been transmitted (sending)</entry>
1723 <entry>ZOOM_EVENT_RECV_DATA</entry>
1724 <entry>Data has been received)</entry>
1727 <entry>ZOOM_EVENT_TIMEOUT</entry>
1728 <entry>Timeout</entry>
1731 <entry>ZOOM_EVENT_UNKNOWN</entry>
1732 <entry>Unknown event</entry>
1735 <entry>ZOOM_EVENT_SEND_APDU</entry>
1736 <entry>An APDU has been transmitted (sending)</entry>
1739 <entry>ZOOM_EVENT_RECV_APDU</entry>
1740 <entry>An APDU has been received</entry>
1743 <entry>ZOOM_EVENT_RECV_RECORD</entry>
1744 <entry>A result-set record has been received</entry>
1747 <entry>ZOOM_EVENT_RECV_SEARCH</entry>
1748 <entry>A search result been received</entry>
1756 <!-- Keep this comment at the end of the file
1761 sgml-minimize-attributes:nil
1762 sgml-always-quote-attributes:t
1765 sgml-parent-document: "yaz.xml"
1766 sgml-local-catalogs: nil
1767 sgml-namecase-general:t