1 /* $Id: api.h,v 1.4 2004-12-02 17:27:03 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
24 * Most functions return an int. Unix-like, 0 means OK,
25 * non-zero means an error. The error info should be available
26 * via zebra_errCode and friends.
34 #include <yaz/proto.h>
35 #include <idzebra/res.h>
36 #include <idzebra/version.h>
38 /* Fixme! Compare string (ignore case) */
40 #define STRCASECMP stricmp
42 #define STRCASECMP strcasecmp
54 } ZebraTransactionStatus;
56 /* Retrieval Record Descriptor */
58 int errCode; /* non-zero if error when fetching this */
59 char *errString; /* error string */
60 int position; /* position of record in result set (1,2,..) */
61 char *buf; /* record buffer (void pointer really) */
63 oid_value format; /* record syntax */
67 } ZebraRetrievalRecord;
69 /* Scan Term Descriptor */
71 int occurrences; /* scan term occurrences */
72 char *term; /* scan term string */
75 typedef struct zebra_session *ZebraHandle;
76 typedef struct zebra_service *ZebraService;
80 * Starting and stopping
83 /* Start Zebra using file 'configName' (usually zebra.cfg) */
84 /* There should be exactly one ZebraService */
85 YAZ_EXPORT ZebraService zebra_start (const char *configName);
86 YAZ_EXPORT ZebraService zebra_start_res (const char *configName,
87 Res def_res, Res over_res);
89 /* Close the whole Zebra */
90 YAZ_EXPORT int zebra_stop (ZebraService zs);
92 /* Report name of each record class (filter) */
93 YAZ_EXPORT void zebra_filter_info(ZebraService zs, void *cd,
94 void (*cb)(void *cd, const char *name));
97 /* Open a ZebraHandle */
98 /* There should be one handle for each thred doing something */
99 /* with zebra, be that searching or indexing. In simple apps */
100 /* one handle is sufficient */
101 YAZ_EXPORT ZebraHandle zebra_open (ZebraService zs);
104 YAZ_EXPORT int zebra_close (ZebraHandle zh);
110 /* last error code */
111 YAZ_EXPORT int zebra_errCode (ZebraHandle zh);
113 /* string representatio of above */
114 YAZ_EXPORT const char *zebra_errString (ZebraHandle zh);
116 /* extra information associated with error */
117 YAZ_EXPORT char *zebra_errAdd (ZebraHandle zh);
119 /* get the result code and addinfo from zh */
120 YAZ_EXPORT int zebra_result (ZebraHandle zh, int *code, char **addinfo);
121 /* FIXME - why is this needed?? -H */
123 /* clear them error things */
124 YAZ_EXPORT void zebra_clearError(ZebraHandle zh);
130 /* Search using PQF Query */
131 YAZ_EXPORT int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
132 const char *setname, int *numhits);
134 /* Search using RPN Query */
135 YAZ_EXPORT int zebra_search_RPN (ZebraHandle zh, ODR o, Z_RPNQuery *query,
136 const char *setname, int *hits);
138 /* Retrieve record(s) */
139 YAZ_EXPORT int zebra_records_retrieve (ZebraHandle zh, ODR stream,
140 const char *setname, Z_RecordComposition *comp,
141 oid_value input_format,
142 int num_recs, ZebraRetrievalRecord *recs);
144 /* Delete Result Set(s) */
145 YAZ_EXPORT int zebra_deleleResultSet(ZebraHandle zh, int function,
146 int num_setnames, char **setnames,
151 YAZ_EXPORT int zebra_scan (ZebraHandle zh, ODR stream,
152 Z_AttributesPlusTerm *zapt,
153 oid_value attributeset,
154 int *position, int *num_entries,
155 ZebraScanEntry **list,
164 /* do authentication */
165 YAZ_EXPORT int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
167 /* Character normalisation on specific register .
168 This routine is subject to change - do not use. */
169 YAZ_EXPORT int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
170 const char *input_str, int input_len,
171 char *output_str, int output_len);
178 YAZ_EXPORT int zebra_create_database (ZebraHandle zh, const char *db);
179 YAZ_EXPORT int zebra_drop_database (ZebraHandle zh, const char *db);
181 YAZ_EXPORT int zebra_admin_shutdown (ZebraHandle zh);
182 YAZ_EXPORT int zebra_admin_start (ZebraHandle zh);
184 YAZ_EXPORT int zebra_shutdown (ZebraService zs);
186 YAZ_EXPORT int zebra_admin_import_begin (ZebraHandle zh, const char *database,
187 const char *record_type);
189 YAZ_EXPORT int zebra_admin_import_segment (ZebraHandle zh,
192 YAZ_EXPORT int zebra_admin_import_end (ZebraHandle zh);
194 int zebra_admin_exchange_record (ZebraHandle zh,
197 const char *recid_buf, size_t recid_len,
200 int zebra_begin_trans (ZebraHandle zh, int rw);
201 int zebra_end_trans (ZebraHandle zh);
202 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
204 int zebra_commit (ZebraHandle zh);
205 int zebra_clean (ZebraHandle zh);
207 int zebra_init (ZebraHandle zh);
208 int zebra_compact (ZebraHandle zh);
209 int zebra_repository_update (ZebraHandle zh, const char *path);
210 int zebra_repository_delete (ZebraHandle zh, const char *path);
211 int zebra_repository_show (ZebraHandle zh, const char *path);
213 int zebra_add_record (ZebraHandle zh, const char *buf, int buf_size);
215 int zebra_insert_record (ZebraHandle zh,
216 const char *recordType,
217 SYSNO *sysno, const char *match, const char *fname,
218 const char *buf, int buf_size,
220 int zebra_update_record (ZebraHandle zh,
221 const char *recordType,
222 SYSNO *sysno, const char *match, const char *fname,
223 const char *buf, int buf_size,
225 int zebra_delete_record (ZebraHandle zh,
226 const char *recordType,
227 SYSNO *sysno, const char *match, const char *fname,
228 const char *buf, int buf_size,
231 YAZ_EXPORT int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
233 int *type, char *out, size_t *len);
235 YAZ_EXPORT int zebra_sort (ZebraHandle zh, ODR stream,
236 int num_input_setnames,
237 const char **input_setnames,
238 const char *output_setname,
239 Z_SortKeySpecList *sort_sequence,
243 int zebra_select_databases (ZebraHandle zh, int num_bases,
244 const char **basenames);
247 int zebra_select_database (ZebraHandle zh, const char *basename);
250 int zebra_shadow_enable (ZebraHandle zh, int value);
253 int zebra_register_statistics (ZebraHandle zh, int dumpdict);
256 int zebra_record_encoding (ZebraHandle zh, const char *encoding);
260 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
262 const char *zebra_get_resource(ZebraHandle zh,
263 const char *name, const char *defaultvalue);
266 YAZ_EXPORT void zebra_pidfname(ZebraService zs, char *path);
276 ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh,
278 int num, zint *positions);
282 ZebraMetaRecord *zebra_meta_records_create_range (ZebraHandle zh,
284 zint start, int num);
287 void zebra_meta_records_destroy (ZebraHandle zh, ZebraMetaRecord *records,