1 /* $Id: zebraapi.h,v 1.12 2004-01-22 11:27:21 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>
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 Res def_res, Res over_res);
88 /* Close the whole Zebra */
89 YAZ_EXPORT int zebra_stop (ZebraService zs);
92 /* Open a ZebraHandle */
93 /* There should be one handle for each thred doing something */
94 /* with zebra, be that searching or indexing. In simple apps */
95 /* one handle is sufficient */
96 YAZ_EXPORT ZebraHandle zebra_open (ZebraService zs);
99 YAZ_EXPORT int zebra_close (ZebraHandle zh);
105 /* last error code */
106 YAZ_EXPORT int zebra_errCode (ZebraHandle zh);
108 /* string representatio of above */
109 YAZ_EXPORT const char *zebra_errString (ZebraHandle zh);
111 /* extra information associated with error */
112 YAZ_EXPORT char *zebra_errAdd (ZebraHandle zh);
114 /* get the result code and addinfo from zh */
115 YAZ_EXPORT int zebra_result (ZebraHandle zh, int *code, char **addinfo);
116 /* FIXME - why is this needed?? -H */
118 /* clear them error things */
119 YAZ_EXPORT void zebra_clearError(ZebraHandle zh);
125 /* Search using PQF Query */
126 YAZ_EXPORT int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
127 const char *setname, int *numhits);
129 /* Search using RPN Query */
130 YAZ_EXPORT int zebra_search_RPN (ZebraHandle zh, ODR o, Z_RPNQuery *query,
131 const char *setname, int *hits);
133 /* Retrieve record(s) */
134 YAZ_EXPORT int zebra_records_retrieve (ZebraHandle zh, ODR stream,
135 const char *setname, Z_RecordComposition *comp,
136 oid_value input_format,
137 int num_recs, ZebraRetrievalRecord *recs);
139 /* Delete Result Set(s) */
140 YAZ_EXPORT int zebra_deleleResultSet(ZebraHandle zh, int function,
141 int num_setnames, char **setnames,
146 YAZ_EXPORT int zebra_scan (ZebraHandle zh, ODR stream,
147 Z_AttributesPlusTerm *zapt,
148 oid_value attributeset,
149 int *position, int *num_entries,
150 ZebraScanEntry **list,
159 /* do authentication */
160 YAZ_EXPORT int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
162 /* Character normalisation on specific register .
163 This routine is subject to change - do not use. */
164 YAZ_EXPORT int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
165 const char *input_str, int input_len,
166 char *output_str, int output_len);
173 YAZ_EXPORT int zebra_create_database (ZebraHandle zh, const char *db);
174 YAZ_EXPORT int zebra_drop_database (ZebraHandle zh, const char *db);
176 YAZ_EXPORT int zebra_admin_shutdown (ZebraHandle zh);
177 YAZ_EXPORT int zebra_admin_start (ZebraHandle zh);
179 YAZ_EXPORT int zebra_shutdown (ZebraService zs);
181 YAZ_EXPORT int zebra_admin_import_begin (ZebraHandle zh, const char *database,
182 const char *record_type);
184 YAZ_EXPORT int zebra_admin_import_segment (ZebraHandle zh,
187 YAZ_EXPORT int zebra_admin_import_end (ZebraHandle zh);
189 int zebra_admin_exchange_record (ZebraHandle zh,
192 const char *recid_buf, size_t recid_len,
195 int zebra_begin_trans (ZebraHandle zh, int rw);
196 int zebra_end_trans (ZebraHandle zh);
197 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
199 int zebra_commit (ZebraHandle zh);
200 int zebra_clean (ZebraHandle zh);
202 int zebra_init (ZebraHandle zh);
203 int zebra_compact (ZebraHandle zh);
204 int zebra_repository_update (ZebraHandle zh, const char *path);
205 int zebra_repository_delete (ZebraHandle zh, const char *path);
206 int zebra_repository_show (ZebraHandle zh, const char *path);
208 int zebra_add_record (ZebraHandle zh, const char *buf, int buf_size);
210 int zebra_insert_record (ZebraHandle zh,
211 const char *recordType,
212 int *sysno, const char *match, const char *fname,
213 const char *buf, int buf_size);
214 int zebra_update_record (ZebraHandle zh,
215 const char *recordType,
216 int* sysno, const char *match, const char *fname,
217 const char *buf, int buf_size,
219 int zebra_delete_record (ZebraHandle zh,
220 const char *recordType,
221 int *sysno, const char *match, const char *fname,
222 const char *buf, int buf_size,
225 YAZ_EXPORT int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
227 int *type, char *out, size_t *len);
229 YAZ_EXPORT int zebra_sort (ZebraHandle zh, ODR stream,
230 int num_input_setnames,
231 const char **input_setnames,
232 const char *output_setname,
233 Z_SortKeySpecList *sort_sequence,
238 int zebra_select_databases (ZebraHandle zh, int num_bases,
239 const char **basenames);
242 int zebra_select_database (ZebraHandle zh, const char *basename);
245 int zebra_shadow_enable (ZebraHandle zh, int value);
248 int zebra_register_statistics (ZebraHandle zh, int dumpdict);
251 int zebra_record_encoding (ZebraHandle zh, const char *encoding);
255 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
257 const char *zebra_get_resource(ZebraHandle zh,
258 const char *name, const char *defaultvalue);
261 YAZ_EXPORT void zebra_pidfname(ZebraService zs, char *path);