2 * Copyright (C) 1994-1998, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.11 2000-03-20 19:08:36 adam
8 * Added remote record import using Z39.50 extended services and Segment
11 * Revision 1.10 2000/03/15 15:00:31 adam
12 * First work on threaded version.
14 * Revision 1.9 2000/02/24 12:31:17 adam
15 * Added zebra_string_norm.
17 * Revision 1.8 1999/11/30 13:48:03 adam
18 * Improved installation. Updated for inclusion of YAZ header files.
20 * Revision 1.7 1999/11/04 15:00:45 adam
21 * Implemented delete result set(s).
23 * Revision 1.6 1999/02/17 11:29:57 adam
24 * Fixed in record_fetch. Minor updates to API.
26 * Revision 1.5 1998/09/22 10:48:19 adam
27 * Minor changes in search API.
29 * Revision 1.4 1998/09/02 13:53:18 adam
30 * Extra parameter decode added to search routines to implement
33 * Revision 1.3 1998/06/22 11:36:48 adam
34 * Added authentication check facility to zebra.
36 * Revision 1.2 1998/06/13 00:14:09 adam
39 * Revision 1.1 1998/06/12 12:22:13 adam
46 #include <yaz/proto.h>
50 /* Retrieval Record Descriptor */
52 int errCode; /* non-zero if error when fetching this */
53 char *errString; /* error string */
54 int position; /* position of record in result set (1,2,..) */
55 char *buf; /* record buffer (void pointer really) */
57 oid_value format; /* record syntax */
59 } ZebraRetrievalRecord;
61 /* Scan Term Descriptor */
63 int occurrences; /* scan term occurrences */
64 char *term; /* scan term string */
67 typedef struct zebra_session *ZebraHandle;
68 typedef struct zebra_service *ZebraService;
70 /* Open Zebra using file 'configName' (usually zebra.cfg) */
71 YAZ_EXPORT ZebraHandle zebra_open (ZebraService zs);
73 /* Search using RPN-Query */
74 YAZ_EXPORT void zebra_search_rpn (ZebraHandle zh, ODR input, ODR output,
75 Z_RPNQuery *query, int num_bases, char **basenames,
78 /* Retrieve record(s) */
79 YAZ_EXPORT void zebra_records_retrieve (ZebraHandle zh, ODR stream,
80 const char *setname, Z_RecordComposition *comp,
81 oid_value input_format,
82 int num_recs, ZebraRetrievalRecord *recs);
85 YAZ_EXPORT void zebra_scan (ZebraHandle zh, ODR stream,
86 Z_AttributesPlusTerm *zapt,
87 oid_value attributeset,
88 int num_bases, char **basenames,
89 int *position, int *num_entries,
90 ZebraScanEntry **list,
93 /* Delete Result Set(s) */
94 YAZ_EXPORT int zebra_deleleResultSet(ZebraHandle zh, int function,
95 int num_setnames, char **setnames,
98 /* Close zebra and destroy handle */
99 YAZ_EXPORT void zebra_close (ZebraHandle zh);
101 /* last error code */
102 YAZ_EXPORT int zebra_errCode (ZebraHandle zh);
103 /* string representatio of above */
104 YAZ_EXPORT const char *zebra_errString (ZebraHandle zh);
106 /* extra information associated with error */
107 YAZ_EXPORT char *zebra_errAdd (ZebraHandle zh);
109 /* number of hits (after search) */
110 YAZ_EXPORT int zebra_hits (ZebraHandle zh);
112 /* do authentication */
113 YAZ_EXPORT int zebra_auth (ZebraService zh, const char *user, const char *pass);
115 /* Character normalisation on specific register .
116 This routine is subject to change - do not use. */
117 YAZ_EXPORT int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
118 const char *input_str, int input_len,
119 char *output_str, int output_len);
121 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
123 YAZ_EXPORT ZebraService zebra_start (const char *configName);
124 YAZ_EXPORT void zebra_stop (ZebraService zs);
126 YAZ_EXPORT void zebra_admin_shutdown (ZebraHandle zh);
127 YAZ_EXPORT void zebra_admin_start (ZebraHandle zh);
129 YAZ_EXPORT void zebra_shutdown (ZebraService zs);
131 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database);
133 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,