1 /* $Id: zebraapi.h,v 1.1 2003-03-04 23:36:29 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003
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
28 #include <yaz/proto.h>
31 /* Fixme! Compare string (ignore case) */
33 #define STRCASECMP stricmp
35 #define STRCASECMP strcasecmp
62 } ZebraTransactionStatus;
64 /* Retrieval Record Descriptor */
66 int errCode; /* non-zero if error when fetching this */
67 char *errString; /* error string */
68 int position; /* position of record in result set (1,2,..) */
69 char *buf; /* record buffer (void pointer really) */
71 oid_value format; /* record syntax */
75 } ZebraRetrievalRecord;
77 /* Scan Term Descriptor */
79 int occurrences; /* scan term occurrences */
80 char *term; /* scan term string */
83 typedef struct zebra_session *ZebraHandle;
84 typedef struct zebra_service *ZebraService;
88 * Starting and stopping
91 /* Start Zebra using file 'configName' (usually zebra.cfg) */
92 /* There should be exactly one ZebraService */
93 YAZ_EXPORT ZebraService zebra_start (const char *configName);
95 /* Close the whole Zebra */
96 YAZ_EXPORT void zebra_stop (ZebraService zs);
99 /* Open a ZebraHandle */
100 /* There should be one handle for each thred doing something */
101 /* with zebra, be that searching or indexing. In simple apps */
102 /* one handle is sufficient */
103 YAZ_EXPORT ZebraHandle zebra_open (ZebraService zs);
106 YAZ_EXPORT void zebra_close (ZebraHandle zh);
112 /* last error code */
113 YAZ_EXPORT int zebra_errCode (ZebraHandle zh);
115 /* string representatio of above */
116 YAZ_EXPORT const char *zebra_errString (ZebraHandle zh);
118 /* extra information associated with error */
119 YAZ_EXPORT char *zebra_errAdd (ZebraHandle zh);
121 /* get the result code and addinfo from zh */
122 YAZ_EXPORT void zebra_result (ZebraHandle zh, int *code, char **addinfo);
123 /* FIXME - why is this needed?? -H */
130 /* Search using RPN-Query */
131 YAZ_EXPORT void zebra_search_rpn (ZebraHandle zh, ODR input, ODR output,
133 const char *setname, int *hits);
135 /* Retrieve record(s) */
136 YAZ_EXPORT void zebra_records_retrieve (ZebraHandle zh, ODR stream,
137 const char *setname, Z_RecordComposition *comp,
138 oid_value input_format,
139 int num_recs, ZebraRetrievalRecord *recs);
141 /* Delete Result Set(s) */
142 YAZ_EXPORT int zebra_deleleResultSet(ZebraHandle zh, int function,
143 int num_setnames, char **setnames,
148 YAZ_EXPORT void zebra_scan (ZebraHandle zh, ODR stream,
149 Z_AttributesPlusTerm *zapt,
150 oid_value attributeset,
151 int *position, int *num_entries,
152 ZebraScanEntry **list,
161 /* do authentication */
162 YAZ_EXPORT int zebra_auth (ZebraHandle zh, const char *user, const char *pass);
164 /* Character normalisation on specific register .
165 This routine is subject to change - do not use. */
166 YAZ_EXPORT int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
167 const char *input_str, int input_len,
168 char *output_str, int output_len);
175 YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db);
178 YAZ_EXPORT void zebra_admin_shutdown (ZebraHandle zh);
179 YAZ_EXPORT void zebra_admin_start (ZebraHandle zh);
181 YAZ_EXPORT void zebra_shutdown (ZebraService zs);
183 YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database,
184 const char *record_type);
186 YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh,
189 void zebra_admin_import_end (ZebraHandle zh);
191 int zebra_admin_exchange_record (ZebraHandle zh,
192 const char *database,
195 const char *recid_buf, size_t recid_len,
198 int zebra_begin_trans (ZebraHandle zh, int rw);
199 void zebra_end_trans (ZebraHandle zh);
200 void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat);
202 int zebra_commit (ZebraHandle zh);
204 int zebra_init (ZebraHandle zh);
205 int zebra_compact (ZebraHandle zh);
206 void zebra_repository_update (ZebraHandle zh);
207 void zebra_repository_delete (ZebraHandle zh);
208 void zebra_repository_show (ZebraHandle zh);
209 int zebra_record_insert (ZebraHandle zh, const char *buf, int len);
211 YAZ_EXPORT void zebra_set_group (ZebraHandle zh, struct recordGroup *rg);
214 YAZ_EXPORT int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
216 int *type, char *out, size_t *len);
218 YAZ_EXPORT void zebra_sort (ZebraHandle zh, ODR stream,
219 int num_input_setnames,
220 const char **input_setnames,
221 const char *output_setname,
222 Z_SortKeySpecList *sort_sequence,
227 int zebra_select_databases (ZebraHandle zh, int num_bases,
228 const char **basenames);
231 int zebra_select_database (ZebraHandle zh, const char *basename);
234 void zebra_shadow_enable (ZebraHandle zh, int value);
237 void zebra_register_statistics (ZebraHandle zh, int dumpdict);
240 int zebra_record_encoding (ZebraHandle zh, const char *encoding);
244 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
246 const char *zebra_get_resource(ZebraHandle zh,
247 const char *name, const char *defaultvalue);