Description: This document is the programmer's guide and reference to the YAZ package version 5.35.1. YAZ is a compact toolkit that provides access to the Z39.50 and SRU/Solr 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.

YAZ User's Guide and Reference
|  | Next

# YAZ User's Guide and Reference

### Sebastian Hammer

### Adam Dickmeiss

### Mike Taylor

### Heikki Levanto

### Dennis Schafroth

### Jakub Skoczen

5.35.1

Copyright © 1995-2025 Index Data

Abstract

This document is the programmer's guide and reference to the YAZ package version 5.35.1. YAZ is a compact toolkit that provides access to the Z39.50 and SRU/Solr 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.

List of Figures

1.1. YAZ layers

List of Tables

3.1. ZOOM Connection Options
3.2. ZOOM sort strategy
3.3. ZOOM Result set Options
3.4. Search Info Report Options
3.5. ZOOM Scan Set Options
3.6. Extended Service Type
3.7. Extended Service Common Options
3.8. Item Order Options
3.9. ILL Request Options
3.10. Record Update Options
3.11. Database Create Options
3.12. Database Drop Options
3.13. ZOOM Event IDs
5.1. Default settings for PDU Initialize Request
5.2. Default settings for PDU Initialize Response
5.3. Default settings for PDU Search Request
5.4. Default settings for PDU Search Response
5.5. Default settings for PDU Present Request
5.6. Default settings for PDU Present Response
5.7. Default settings for Delete Result Set Request
5.8. Default settings for Delete Result Set Response
5.9. Default settings for Scan Request
5.10. Default settings for Scan Response
5.11. Default settings for Trigger Resource Control Request
5.12. Default settings for Resource Control Request
5.13. Default settings for Resource Control Response
5.14. Default settings for Access Control Request
5.15. Default settings for Access Control Response
5.16. Default settings for Segment
5.17. Default settings for Close
7.1. Common Bib-1 attributes
7.2. Special attribute combos
7.3. CCL directives
7.4. Facet attributes
8.1. ODR Error codes

List of Examples

4.1. Running the GFS on Unix
4.2. Setting up Apache as SRU Frontend
4.3. Running a server with local access only
7.1. PQF queries using simple terms
7.2. PQF boolean operators
7.3. PQF references to result sets
7.4. Attributes for terms
7.5. PQF Proximity queries
7.6. PQF specification of search term type
7.7. PQF mixed queries
7.8. CCL queries
7.9. CCL profile
7.10. CQL to RPN mapping file
7.11. CQL to RPN string attributes
7.12. CQL to RPN using Bath Profile
7.13. Create OID on stack
7.14. Using oid_oiddotstring_to_oid
7.15. Using odr_getoidbystr
7.16. Create OID with YAZ DB
7.17. Use a built-in OID
7.18. Display of MARC record
7.19. MARC21 backend
7.20. MARCXML backend
7.21. RDF-lookup backend
8.1. Encoding and decoding functions
8.2. Encoding and decoding of an integer
8.3. Element Path for record

|  | Next
|  | Chapter 1. Introduction