X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzoom.xml;h=ac9eadb45350089317b2270e8f3f60a3035f2b04;hp=3bd7080e2b6c87ec5b94e8ae7c8b7488d9f4ff7b;hb=19411dcc2419807b0b81e7ad05f63880eba58d22;hpb=c20830c3e36706390cc7a15c2a3a4ffa071dc36a diff --git a/doc/zoom.xml b/doc/zoom.xml index 3bd7080..ac9eadb 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -3,6 +3,8 @@ ZOOM_connection_errcode(c) ZOOM_connection_errmsg(c) ZOOM_connection_addinfo(c) +ZOOM_connection_addinfo(c) +ZOOM_connection_diagset(c); ZOOM_diag_str(error) ZOOM_resultset_record_immediate(s, pos) ZOOM_resultset_cache_reset(r) @@ -15,8 +17,9 @@ ZOOM_options_setl(opt, name, value, len) ZOOM_options_get_bool(opt, name, defa) ZOOM_options_get_int(opt, name, defa) ZOOM_options_set_int(opt, name, value) +ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm) +ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) --> - ZOOM &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is @@ -28,9 +31,17 @@ ZOOM_options_set_int(opt, name, value) - A recent addition to &yaz; is SRW support. You can now make - SRW ZOOM connections by specifying scheme http:// - for the hostname for a connection. + 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: + sru=get,http://sru.miketaylor.org.uk:80/sru.pl @@ -45,7 +56,7 @@ ZOOM_options_set_int(opt, name, value) There are other language bindings available for &yaz;, and still more are in active development. See the - ZOOM web-site for + ZOOM web-site for more information. @@ -71,7 +82,7 @@ ZOOM_options_set_int(opt, name, value) protocol behavior, that describes how the API maps to the Z39.50 protocol. - Connections + Connections The Connection object is a session with a target. @@ -84,7 +95,7 @@ ZOOM_options_set_int(opt, name, value) void ZOOM_connection_connect(ZOOM_connection c, const char *host, int portnum); - void ZOOM_connection_destroy (ZOOM_connection c); + void ZOOM_connection_destroy(ZOOM_connection c); Connection objects are created with either function @@ -104,7 +115,18 @@ ZOOM_options_set_int(opt, name, value) You can prefix the host with a scheme followed by colon. The default scheme is tcp (Z39.50 protocol). - The scheme http selects SRW over HTTP. + The scheme http selects SRU over HTTP. + + + You can prefix the scheme-qualified host-string with one or more + comma-separated + key=value + sequences, each of which represents an option to be set into the + connection structure before the + protocol-level connection is forged and the initialization + handshake takes place. This facility can be used to provide + authentication credentials, as in host-strings such as: + user=admin,password=halfAm4n,tcp:localhost:8017/db Connection objects should be destroyed using the function @@ -139,7 +161,8 @@ ZOOM_options_set_int(opt, name, value) ZOOM_connection_option_getl returns the value for an option given by key. - ZOOM Connection Options +
+ ZOOM Connection Options @@ -237,20 +260,39 @@ ZOOM_options_set_int(opt, name, value) mediumSetElementSetName The element set name to be for medium-sized result sets. none + + init_opt_search, init_opt_present, init_opt_delSet, etc. + After a successful Init, these options may be interrogated to + discover whether the server claims to support the specified + operations. + none + + sru + SRU transport type. Must be either soap, + get or post. + soap + + sru_version + SRU/SRW version. Should be 1.1, or + 1.2. This is , prior to connect, the version + to offer (highest version). And following connect (in fact + first operation), holds the negotiated version with the server + (same or lower version). + 1.2
If either option lang or charset is set, then - + Character Set and Language Negotiation is in effect. - int ZOOM_connection_error (ZOOM_connection c, const char **cp, - const char **addinfo); - int ZOOM_connection_error_x (ZOOM_connection c, const char **cp, - const char **addinfo, const char **dset); + int ZOOM_connection_error(ZOOM_connection c, const char **cp, + const char **addinfo); + int ZOOM_connection_error_x(ZOOM_connection c, const char **cp, + const char **addinfo, const char **dset); Function ZOOM_connection_error checks for @@ -263,7 +305,8 @@ ZOOM_options_set_int(opt, name, value) of ZOOM_connection_error that is capable of returning name of diagnostic set in dset. - Z39.50 Protocol behavior + + Z39.50 Protocol behavior The calls ZOOM_connection_new and ZOOM_connection_connect establishes a TCP/IP @@ -301,14 +344,15 @@ ZOOM_options_set_int(opt, name, value) API cannot tell the outcome (yet). - SRW Protocol behavior + + SRU Protocol behavior - The SRW protocol doesn't feature an Inititialize Request, so + The SRU protocol 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 SRW and they are ignored. However, future versions + affect SRU and they are ignored. However, future versions of &yaz; might honor implementationName and put that as part of User-Agent header for HTTP requests. @@ -348,7 +392,7 @@ ZOOM_options_set_int(opt, name, value) sort criteria using the same string notation for sort as offered by the YAZ client. - Protocol behavior + Protocol behavior The query object is just an interface for the member Query in the SearchRequest. The sortby-function is an interface to the @@ -362,17 +406,15 @@ ZOOM_options_set_int(opt, name, value) a target. - ZOOM_resultset ZOOM_connection_search(ZOOM_connection, - ZOOM_query q); + ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q); ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); - void ZOOM_resultset_destroy(ZOOM_resultset r); Function ZOOM_connection_search creates - a result set given a connection and query. + a result set given a connection and query. Destroy a result set by calling ZOOM_resultset_destroy. Simple clients may using PQF only may use function @@ -380,14 +422,12 @@ ZOOM_options_set_int(opt, name, value) creating query objects is not necessary. - void ZOOM_resultset_option_set (ZOOM_resultset r, - const char *key, - const char *val); + void ZOOM_resultset_option_set(ZOOM_resultset r, + const char *key, const char *val); - const char *ZOOM_resultset_option_get (ZOOM_resultset r, - const char *key); + const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key); - size_t ZOOM_resultset_size (ZOOM_resultset r); + size_t ZOOM_resultset_size(ZOOM_resultset r); Functions ZOOM_resultset_options_set and @@ -399,7 +439,8 @@ ZOOM_options_set_int(opt, name, value) The number of hits also called result-count is returned by function ZOOM_resultset_size. - ZOOM Result set Options +
ZOOM Result set Options @@ -416,13 +457,21 @@ ZOOM_options_set_int(opt, name, value) startOffset 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 + ZOOM_resultset_search_pqf and must be set before any of + these functions are invoked. If a range of + records must be fetched manually after search, + function ZOOM_resultset_records should be used. 0 - countNumber of records to be retrieved. + countNumber 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. 0 presentChunkThe number of records to be - requested from the server in each chunk (present requst). The + requested from the server in each chunk (present request). The value 0 means to request all the records in a single chunk. (The old step option is also supported for the benefit of old applications.) @@ -445,6 +494,13 @@ ZOOM_options_set_int(opt, name, value) If this option isn't set, the ZOOM module will automatically allocate a result set name. default + + rpnCharsetCharacter set for RPN terms. + If this is set, ZOOM C will assume that the ZOOM application is + running UTF-8. Terms in RPN queries are then converted to the + rpnCharset. If this is unset, ZOOM C will not assume any encoding + of RPN terms and no conversion is performed. + none
@@ -463,7 +519,8 @@ ZOOM_options_set_int(opt, name, value) Read searchresult.size to determine the number of items. - Search Info Report options +
Search Info Report Options @@ -508,7 +565,7 @@ ZOOM_options_set_int(opt, name, value)
- + Z39.50 Protocol behavior The creation of a result set involves at least a SearchRequest @@ -560,23 +617,23 @@ ZOOM_options_set_int(opt, name, value) to specify one elementSetName option rather than three. - - SRW Protocol behavior + + SRU Protocol behavior Current version of &yaz; does not take advantage of a result set id - returned by the SRW server. Future versions might do, however. + returned by the SRU server. Future versions might do, however. Since, the ZOOM driver does not save result set IDs any - present (retrieval) is transformed to a SRW SearchRetrieveRequest + present (retrieval) is transformed to a SRU SearchRetrieveRequest with same query but, possibly, different offsets. - Option schema specifies SRW schema + Option schema specifies SRU schema for retrieval. However, options elementSetName and preferredRecordSyntax are ignored. Options start and count - are supported by SRW. + are supported by SRU. The remaining options piggyback, smallSetUpperBound, @@ -587,18 +644,18 @@ ZOOM_options_set_int(opt, name, value) unsupported. - SRW supports CQL queries, not PQF. + SRU supports CQL queries, not PQF. If PQF is used, however, the PQF query is transferred anyway using non-standard element pQuery in - SRW SearchRetrieveRequest. + SRU SearchRetrieveRequest. - Unfortunately, SRW does not define a database setting. Hence, + Unfortunately, SRU 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 ZOOM_connection_connect acts as a - database (at least for the &yaz; SRW server). + database (at least for the &yaz; SRU server). @@ -608,17 +665,20 @@ ZOOM_options_set_int(opt, name, value) created from result sets. - void ZOOM_resultset_records (ZOOM_resultset r, - ZOOM_record *recs, - size_t start, size_t count); - ZOOM_record ZOOM_resultset_record (ZOOM_resultset s, size_t pos); + void ZOOM_resultset_records(ZOOM_resultset r, + ZOOM_record *recs, + size_t start, size_t count); + ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos); - const char *ZOOM_record_get (ZOOM_record rec, const char *type, - size_t *len); + const char *ZOOM_record_get(ZOOM_record rec, const char *type, + size_t *len); - ZOOM_record ZOOM_record_clone (ZOOM_record rec); + int ZOOM_record_error(ZOOM_record rec, const char **msg, + const char **addinfo, const char **diagset); - void ZOOM_record_destroy (ZOOM_record rec); + ZOOM_record ZOOM_record_clone(ZOOM_record rec); + + void ZOOM_record_destroy(ZOOM_record rec); References to temporary records are returned by functions @@ -638,6 +698,12 @@ ZOOM_options_set_int(opt, name, value) If no record could be obtained NULL is returned. + Error information for a record can be checked with + ZOOM_record_error which returns non-zero + (error code) if record is in error, called Surrogate + Diagnostics in Z39.50. + + Function ZOOM_resultset_records retrieves a number of records from a result set. Parameter start and count specifies the range of records to @@ -694,6 +760,12 @@ ZOOM_options_set_int(opt, name, value) const char *. + schema + The schema of the record is returned + as a C null-terminated string. Return type is + const char *. + + render The record is returned in a display friendly format. Upon completion buffer is returned @@ -714,9 +786,9 @@ ZOOM_options_set_int(opt, name, value) xml The record is returned in XML if possible. - SRW/SRU and Z39.50 records with transfer syntax XML are + SRU and Z39.50 records with transfer syntax XML are returned verbatim. MARC records are returned in - + MARCXML (converted from ISO2709 to MARCXML by YAZ). @@ -734,20 +806,17 @@ ZOOM_options_set_int(opt, name, value) Most - - MARC21 - + MARC21 records uses the - - MARC-8 - + MARC-8 character set encoding. An application that wishes to display in Latin-1 would use render; charset=marc8,iso-8859-1 - Z39.50 Protocol behavior + + Z39.50 Protocol behavior The functions ZOOM_resultset_record and ZOOM_resultset_records inspects the client-side @@ -766,9 +835,10 @@ ZOOM_options_set_int(opt, name, value) now. - SRW Protocol behavior + + SRU Protocol behavior - The ZOOM driver for SRW treats records returned by a SRW server + The ZOOM driver for SRU treats records returned by a SRU server as if they where Z39.50 records with transfer syntax XML and no element set name or database name. @@ -783,14 +853,16 @@ ZOOM_options_set_int(opt, name, value) - The Scan interface is Z39.50 only. SRW version 1.0 does not - support this. + The Scan interface is supported for both Z39.50 and SRU. ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c, const char *startpqf); + ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c, + ZOOM_query q); + size_t ZOOM_scanset_size(ZOOM_scanset scan); const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, @@ -799,10 +871,10 @@ ZOOM_options_set_int(opt, name, value) const char * ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, int *occ, size_t *len); - void ZOOM_scanset_destroy (ZOOM_scanset scan); + void ZOOM_scanset_destroy(ZOOM_scanset scan); const char *ZOOM_scanset_option_get(ZOOM_scanset scan, - const char *key); + const char *key); void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key, const char *val); @@ -846,8 +918,15 @@ ZOOM_options_set_int(opt, name, value) @attr 1=4 @attr 6=2 "science o" + + + The ZOOM_connecton_scan1 is a newer and + more generic alternative to ZOOM_connection_scan + which allows to use both CQL and PQF for Scan. + - ZOOM Scan Set Options +
+ ZOOM Scan Set Options @@ -875,12 +954,19 @@ ZOOM_options_set_int(opt, name, value) scanStatusAn integer indicating the Scan Status of last scan. 0 + + rpnCharsetCharacter set for RPN terms. + If this is set, ZOOM C will assume that the ZOOM application is + running UTF-8. Terms in RPN queries are then converted to the + rpnCharset. If this is unset, ZOOM C will not assume any encoding + of RPN terms and no conversion is performed. + none
- Extended Services + Extended Services ZOOM offers an interface to a subset of the Z39.50 extended services as well as a few privately defined ones: @@ -889,35 +975,35 @@ ZOOM_options_set_int(opt, name, value) Z39.50 Item Order (ILL). - See . + See . Record Update. This allows a client to insert, modify or delete records. - See . + See . Database Create. This a non-standard feature. Allows a client to create a database. - See . + See . Database Drop. This a non-standard feature. Allows a client to delete/drop a database. - See . + See . Commit operation. This a non-standard feature. Allows a client to commit operations. - See . + See . @@ -958,7 +1044,8 @@ ZOOM_options_set_int(opt, name, value) package type to be sent. - Extended Service Common Options +
+ Extended Service Common Options @@ -992,10 +1079,19 @@ ZOOM_options_set_int(opt, name, value) create + waitAction + + Wait action for package. Possible values: + wait, waitIfPossible, + dontWait or dontReturnPackage. + + waitIfPossible + + targetReference Target Reference. This is part of the response as returned - by the server. Read it after a succesful operation. + by the server. Read it after a successful operation. none @@ -1003,13 +1099,14 @@ ZOOM_options_set_int(opt, name, value)
- Item Order + Item Order For Item Order, type must be set to itemorder in ZOOM_package_send. - Item Order Options +
+ Item Order Options @@ -1048,13 +1145,14 @@ ZOOM_options_set_int(opt, name, value) - Record Update + Record Update For Record Update, type must be set to update in ZOOM_package_send. -
Record Update Options +
+ Record Update Options @@ -1077,7 +1175,7 @@ ZOOM_options_set_int(opt, name, value) recordDelete, elementUpdate. - specialUpdate + specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate) recordIdOpaque @@ -1095,6 +1193,19 @@ ZOOM_options_set_int(opt, name, value) none + recordOpaque + Specifies an opaque record which is + encoded as an ASN.1 ANY type with the OID as tiven by option + syntax (see below). + Option recordOpaque is an alternative + to record - and record option (above) is + 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. + + none + + syntax The record syntax (transfer syntax). Is a string that is a known record syntax. @@ -1106,19 +1217,49 @@ ZOOM_options_set_int(opt, name, value) Database from connection object Default + + correlationInfo.note + Correlation Info Note (string) + none + + + correlationInfo.id + Correlation Info ID (integer) + none + + + elementSetName + Element Set for Record + none + + + updateVersion + Record Update version which holds one of the values + 1, 2 or 3. Each version has a distinct OID: + 1.2.840.10003.9.5 + (first version) , + 1.2.840.10003.9.5.1 + (second version) and + 1.2.840.10003.9.5.1.1 + (third and + newest version). + + 3 +
- Database Create + Database Create For Database Create, type must be set to create in ZOOM_package_send. - Database Create Options +
+ Database Create Options @@ -1141,13 +1282,14 @@ ZOOM_options_set_int(opt, name, value)
- Database Drop + Database Drop For Database Drop, type must be set to drop in ZOOM_package_send. - Database Create Options +
+ Database Drop Options @@ -1170,14 +1312,15 @@ ZOOM_options_set_int(opt, name, value)
- Commit Operation + Commit Operation For Commit, type must be set to commit in ZOOM_package_send. - Protocol behavior + + Protocol behavior All the extended services are Z39.50-only. @@ -1199,26 +1342,26 @@ ZOOM_options_set_int(opt, name, value) an associative array / hash. - ZOOM_options ZOOM_options_create (void); + ZOOM_options ZOOM_options_create(void); - ZOOM_options ZOOM_options_create_with_parent (ZOOM_options parent); + ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent); - void ZOOM_options_destroy (ZOOM_options opt); + void ZOOM_options_destroy(ZOOM_options opt); - const char *ZOOM_options_get (ZOOM_options opt, const char *name); + const char *ZOOM_options_get(ZOOM_options opt, const char *name); - void ZOOM_options_set (ZOOM_options opt, const char *name, - const char *v); + void ZOOM_options_set(ZOOM_options opt, const char *name, + const char *v); typedef const char *(*ZOOM_options_callback) - (void *handle, const char *name); + (void *handle, const char *name); ZOOM_options_callback - ZOOM_options_set_callback (ZOOM_options opt, - ZOOM_options_callback c, - void *handle); + ZOOM_options_set_callback(ZOOM_options opt, + ZOOM_options_callback c, + void *handle); Events @@ -1227,7 +1370,7 @@ ZOOM_options_set_int(opt, name, value) with events. - int ZOOM_event (int no, ZOOM_connection *cs); + int ZOOM_event(int no, ZOOM_connection *cs); The ZOOM_event executes pending events for @@ -1256,7 +1399,8 @@ ZOOM_options_set_int(opt, name, value) (integer) for the last event. - ZOOM Event IDs +
+ ZOOM Event IDs