1 /* $Id: index.h,v 1.210 2007-11-30 12:19:08 adam Exp $
2 Copyright (C) 1995-2007
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <idzebra/version.h>
29 #include <idzebra/util.h>
30 #include <idzebra/flock.h>
33 #include <sys/times.h>
37 #include <yaz/timing.h>
38 #include <idzebra/dict.h>
39 #include <idzebra/isams.h>
40 #include <idzebra/isamc.h>
41 #include <idzebra/isamb.h>
43 #include <idzebra/recgrs.h>
45 #include <idzebra/api.h>
56 #define ISAM_DEFAULT "b"
58 enum dirsKind { dirs_dir, dirs_file };
73 void getFnameTmp(Res res, char *fname, int no);
75 struct dirs_info *dirs_open(Dict dict, const char *rep, int rw);
76 struct dirs_info *dirs_fopen(Dict dict, const char *path, int rw);
77 struct dirs_entry *dirs_read(struct dirs_info *p);
78 struct dirs_entry *dirs_last(struct dirs_info *p);
79 void dirs_mkdir(struct dirs_info *p, const char *src, time_t mtime);
80 void dirs_rmdir(struct dirs_info *p, const char *src);
81 void dirs_add(struct dirs_info *p, const char *src, zint sysno, time_t mtime);
82 void dirs_del(struct dirs_info *p, const char *src);
83 void dirs_free(struct dirs_info **pp);
85 struct dir_entry *dir_open(const char *rep, const char *base,
87 void dir_sort(struct dir_entry *e);
88 void dir_free(struct dir_entry **e_p);
90 void repositoryUpdate(ZebraHandle zh, const char *path);
91 void repositoryAdd(ZebraHandle zh, const char *path);
92 void repositoryDelete(ZebraHandle zh, const char *path);
93 void repositoryShow(ZebraHandle zh, const char *path);
95 void inv_prstat(ZebraHandle zh);
96 void inv_compact(BFiles bfs);
97 void key_input(ZebraHandle zh, int nkeys, int cache, Res res);
98 ISAMS_M *key_isams_m(Res res, ISAMS_M *me);
99 ISAMC_M *key_isamc_m(Res res, ISAMC_M *me);
101 #define FNAME_DICT "dict"
102 #define FNAME_ISAM "isam"
103 #define FNAME_ISAMC "isamc"
104 #define FNAME_ISAMS "isams"
105 #define FNAME_CONFIG "zebra.cfg"
107 #define GMATCH_DICT "gmatch"
108 #define FMATCH_DICT "fmatch%d"
110 void zebra_lock_prefix(Res res, char *dst);
112 #define FNAME_MAIN_LOCK "zebraidx.LCK"
113 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
114 #define FNAME_ORG_LOCK "zebraorg.LCK"
115 #define FNAME_TOUCH_TIME "zebraidx.time"
117 typedef struct zebra_set *ZebraSet;
119 typedef struct zebra_rank_class {
120 struct rank_control *control;
123 struct zebra_rank_class *next;
127 #include "key_block.h"
129 struct zebra_register {
137 zebra_sort_index_t sort_index;
138 int registerState; /* 0 (no commit pages), 1 (use commit pages) */
139 time_t registerChange;
142 ZebraExplainInfo zei;
144 char *server_path_prefix;
146 zebra_maps_t zebra_maps;
147 ZebraRankClass rank_classes;
153 zebra_rec_keys_t keys;
154 zebra_rec_keys_t sortKeys;
156 zebra_key_block_t key_block;
159 struct zebra_service {
162 struct zebra_session *sessions;
163 struct zebra_register *regs;
164 Zebra_mutex_cond session_lock;
167 const char *path_root;
168 RecTypeClass record_classes;
174 struct zebra_session {
175 struct zebra_session *next;
176 struct zebra_service *service;
177 struct zebra_register *reg;
179 char *xadmin_databaseName;
187 ZebraLockHandle lock_normal;
188 ZebraLockHandle lock_shadow;
209 int m_segment_indexing;
211 zint records_inserted;
212 zint records_updated;
213 zint records_deleted;
214 zint records_processed;
215 zint records_skipped;
216 char *record_encoding;
218 yaz_iconv_t iconv_to_utf8;
219 yaz_iconv_t iconv_from_utf8;
223 const char *m_record_id;
224 const char *m_record_type;
227 int m_explain_database;
229 int m_file_verbose_limit;
231 void *store_data_buf;
232 size_t store_data_size;
235 struct zebra_limit *m_limit;
237 int (*break_handler_func)(void *client_data);
238 void *break_handler_data;
242 struct term_set_entry {
244 struct term_set_entry *next;
247 struct term_set_list {
248 struct term_set_entry *first;
249 struct term_set_entry *last;
253 void zebra_limit_destroy(struct zebra_limit *zl);
254 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
255 void zebra_limit_for_rset(struct zebra_limit *zl,
256 int (**filter_func)(const void *buf, void *data),
257 void (**filter_destroy)(void *data),
260 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
262 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
263 const Odr_oid *attributeSet,
264 NMEM stream, NMEM rset_nmem,
265 Z_SortKeySpecList *sort_sequence,
266 int num_bases, const char **basenames,
269 ZEBRA_RES rpn_get_top_approx_limit(ZebraHandle zh, Z_RPNStructure *zs,
272 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
273 const Odr_oid *attributeset,
274 int num_bases, char **basenames,
275 int *position, int *num_entries, ZebraScanEntry **list,
276 int *is_partial, const char *set_name);
278 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
279 const char *term, int length_term, const char *flags,
280 int preserve_position, int term_type, NMEM rset_nmem,
281 struct rset_key_control *kctrl, int scope,
282 struct ord_list *ol, const char *index_type,
283 zint hits_limit, const char *term_ref_id);
285 ZEBRA_RES resultSetGetBaseNames(ZebraHandle zh, const char *setname,
286 const char ***basenames, int *num_bases);
288 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
289 const char *db, const char *index_name,
291 ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov);
292 ZebraSet resultSetGet(ZebraHandle zh, const char *name);
293 ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
294 int num_bases, char **basenames,
296 zint *hits, int *estimated_hit_count);
297 RSET resultSetRef(ZebraHandle zh, const char *resultSetId);
298 void resultSetDestroy(ZebraHandle zh, int num_names, char **names,
300 ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
301 int num_input_setnames, const char **input_setnames,
302 const char *output_setname,
303 Z_SortKeySpecList *sort_sequence, int *sort_status);
304 ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
305 ZebraSet sset, RSET rset,
306 Z_SortKeySpecList *sort_sequence,
308 ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet, RSET rset,
310 void resultSetInvalidate(ZebraHandle zh);
312 int zebra_record_fetch(ZebraHandle zh, const char *setname,
313 zint sysno, int score,
315 const Odr_oid *input_format, Z_RecordComposition *comp,
316 const Odr_oid **output_format, char **rec_bufp,
317 int *rec_lenp, char **basenamep,
320 void extract_get_fname_tmp(ZebraHandle zh, char *fname, int no);
322 void extract_snippet(ZebraHandle zh, zebra_snippets *sn,
323 struct ZebraRecStream *stream, RecType rt,
324 void *recTypeClientData);
326 int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
327 zebra_snippets *snippets);
329 void zebra_index_merge(ZebraHandle zh);
331 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
332 const char *buf, size_t buf_size,
333 enum zebra_recctrl_action_t action,
335 const char *recordType,
337 const char *match_criteria,
340 ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
341 struct ZebraRecStream *stream,
342 enum zebra_recctrl_action_t action,
344 const char *recordType,
346 const char *match_criteria,
349 void *recTypeClientData,
352 YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream,
353 const char *buf, size_t sz);
354 YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream,
355 int fd, off_t start_offset);
356 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
358 ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh, zebra_rec_keys_t reckeys,
359 zebra_snippets *snippets);
360 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
361 zint sysno, zebra_snippets *snippets);
363 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
365 ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
368 ZEBRA_RES zebra_begin_read(ZebraHandle zh);
369 ZEBRA_RES zebra_end_read(ZebraHandle zh);
371 int zebra_file_stat(const char *file_name, struct stat *buf,
374 Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
375 int compact_flag, Res res);
377 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
378 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
380 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream,
381 const char *index_type,
382 char **dst, const char *src);
384 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
386 void zebra_term_untrans(ZebraHandle zh, const char *index_type,
387 char *dst, const char *src);
389 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
390 Z_AttributesPlusTerm *zapt,
391 const char *index_type,
392 const char *xpath_use,
393 const Odr_oid *curAttributeSet,
396 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
397 Z_AttributeList *attr_list,
398 zinfo_index_category_t cat,
399 const char *index_type,
400 const Odr_oid *curAttributeSet,
403 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
404 Z_SortAttributes *sortAttributes,
408 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
409 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
410 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
411 ZEBRA_RES zebra_remove_file_match(ZebraHandle zh);
413 struct rpn_char_map_info
419 void rpn_char_map_prepare(struct zebra_register *reg, zebra_map_t zm,
420 struct rpn_char_map_info *map_info);
422 ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
426 void zebra_set_partial_result(ZebraHandle zh);
428 int zebra_check_res(Res res);
430 #define FIRST_IN_FIELD_STR "\001^"
431 #define FIRST_IN_FIELD_CHAR 1
432 #define FIRST_IN_FIELD_LEN 2
434 ZEBRA_RES zebra_term_limits_APT(ZebraHandle zh,
435 Z_AttributesPlusTerm *zapt,
436 zint *hits_limit_value,
437 const char **term_ref_id_str,
440 ZEBRA_RES rpn_facet(ZebraHandle zh, ODR stream,
441 Z_AttributesPlusTerm *zapt,
442 const Odr_oid *attributeset,
443 int *position, int *num_entries,
444 ZebraScanEntry **list,
445 int *is_partial, const char *set_name);
447 ZEBRA_RES zebra_result_recid_to_sysno(ZebraHandle zh,
450 zint *sysnos, int *no_sysnos);
458 * indent-tabs-mode: nil
460 * vim: shiftwidth=4 tabstop=8 expandtab