YAZ User’s Guide and Reference Sebastian Hammer Adam Dickmeiss Mike Taylor Heikki Levanto YAZ User’s Guide and Reference by Sebastian Hammer by Adam Dickmeiss by Mike Taylor by Heikki Levanto Copyright © 1995-2005 Index Data This document is the programmer’s guide and reference to the YAZ package version 2.1.4. YAZ is a compact toolkit that provides access to the Z39.50 and SRW/SRU protocols, as well as a set of higher-level tools for implementing the server and client roles, respectively. The documentation can be used on its own, or as a reference when looking at the example applications provided with the package. Table of Contents 1. Introduction............................................................................................................................................1 Reading this Manual ..........................................................................................................................1 The API ..............................................................................................................................................2 2. Compilation and Installation................................................................................................................5 Introduction........................................................................................................................................5 UNIX..................................................................................................................................................5 Compiling from source on Unix...............................................................................................5 How to make apps using YAZ on UNIX..................................................................................8 WIN32................................................................................................................................................9 Compiling from Source on WIN32 ..........................................................................................9 How to make apps using YAZ on WIN32..............................................................................11 3. ZOOM...................................................................................................................................................13 Connections......................................................................................................................................13 Z39.50 Protocol behavior .......................................................................................................15 SRW Protocol behavior ..........................................................................................................16 Queries .............................................................................................................................................16 Protocol behavior....................................................................................................................16 Result sets ........................................................................................................................................16 Z39.50 Protocol behavior .......................................................................................................18 SRW Protocol behavior ..........................................................................................................18 Records.............................................................................................................................................19 Z39.50 Protocol behavior .......................................................................................................20 SRW Protocol behavior ..........................................................................................................20 Scan..................................................................................................................................................21 Options .............................................................................................................................................22 Events...............................................................................................................................................22 4. Generic server ......................................................................................................................................24 Introduction......................................................................................................................................24 The Database Frontend ....................................................................................................................24 The Backend API .............................................................................................................................25 Your main() Routine.........................................................................................................................25 The Backend Functions....................................................................................................................27 Init...........................................................................................................................................27 Search and retrieve .................................................................................................................29 Delete......................................................................................................................................31 scan.........................................................................................................................................32 Application Invocation.....................................................................................................................33 Virtual Hosts ....................................................................................................................................36 5. The YAZ client .....................................................................................................................................39 Introduction......................................................................................................................................39 Invoking the YAZ client...................................................................................................................39 Commands .......................................................................................................................................40 Searching..........................................................................................................................................45 iii 6. The Z39.50 ASN.1 Module..................................................................................................................47 Introduction......................................................................................................................................47 Preparing PDUs................................................................................................................................47 Object Identifiers..............................................................................................................................48 EXTERNAL Data ............................................................................................................................49 PDU Contents Table.........................................................................................................................51 7. SOAP and SRW ...................................................................................................................................57 Introduction......................................................................................................................................57 HTTP................................................................................................................................................57 SOAP Packages................................................................................................................................57 SRW .................................................................................................................................................59 8. Supporting Tools..................................................................................................................................62 Query Syntax Parsers .......................................................................................................................62 Prefix Query Format ...............................................................................................................62 Using Proximity Operators with PQF...........................................................................64 PQF queries...................................................................................................................65 CCL ........................................................................................................................................67 CCL Syntax...................................................................................................................68 CCL Qualifiers..............................................................................................................69 Qualifier specification .........................................................................................69 Qualifier alias ......................................................................................................71