1 /* $Id: index.h,v 1.188 2006-12-22 12:14:25 adam Exp $
2 Copyright (C) 1995-2006
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>
34 #include <sys/times.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 ZebraMaps 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;
170 zebra_timing_t timing;
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 char *record_encoding;
217 yaz_iconv_t iconv_to_utf8;
218 yaz_iconv_t iconv_from_utf8;
222 const char *m_record_id;
223 const char *m_record_type;
226 int m_explain_database;
228 int m_file_verbose_limit;
230 void *store_data_buf;
231 size_t store_data_size;
234 struct zebra_limit *m_limit;
238 struct term_set_entry {
240 struct term_set_entry *next;
243 struct term_set_list {
244 struct term_set_entry *first;
245 struct term_set_entry *last;
249 void zebra_limit_destroy(struct zebra_limit *zl);
250 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
251 void zebra_limit_for_rset(struct zebra_limit *zl,
252 int (**filter_func)(const void *buf, void *data),
253 void (**filter_destroy)(void *data),
256 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
258 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
259 oid_value attributeSet,
260 NMEM stream, NMEM rset_nmem,
261 Z_SortKeySpecList *sort_sequence,
262 int num_bases, char **basenames,
265 ZEBRA_RES rpn_get_top_approx_limit(ZebraHandle zh, Z_RPNStructure *zs,
268 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
269 oid_value attributeset,
270 int num_bases, char **basenames,
271 int *position, int *num_entries, ZebraScanEntry **list,
272 int *is_partial, RSET limit_set);
274 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
275 const char *term, int length_term, const char *flags,
276 int preserve_position, int term_type, NMEM rset_nmem,
277 struct rset_key_control *kctrl, int scope,
278 struct ord_list *ol, int reg_type,
279 zint hits_limit, const char *term_ref_id);
281 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
282 const char *db, const char *index_name,
284 ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov);
285 ZebraSet resultSetGet(ZebraHandle zh, const char *name);
286 ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
287 int num_bases, char **basenames,
288 const char *setname);
289 RSET resultSetRef(ZebraHandle zh, const char *resultSetId);
290 void resultSetDestroy(ZebraHandle zh, int num_names, char **names,
292 ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
293 int num_input_setnames, const char **input_setnames,
294 const char *output_setname,
295 Z_SortKeySpecList *sort_sequence, int *sort_status);
296 ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
297 ZebraSet sset, RSET rset,
298 Z_SortKeySpecList *sort_sequence,
300 ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet, RSET rset,
302 void resultSetInvalidate(ZebraHandle zh);
304 int zebra_record_fetch(ZebraHandle zh, zint sysno, int score,
305 zebra_snippets *hit_snippet, ODR stream,
306 oid_value input_format, Z_RecordComposition *comp,
307 oid_value *output_format, char **rec_bufp,
308 int *rec_lenp, char **basenamep,
311 void extract_get_fname_tmp(ZebraHandle zh, char *fname, int no);
313 void zebra_index_merge(ZebraHandle zh);
315 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
316 const char *buf, size_t buf_size,
319 const char *recordType,
321 const char *match_criteria,
326 ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
327 struct ZebraRecStream *stream,
330 const char *recordType,
332 const char *match_criteria,
337 void *recTypeClientData,
340 YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream,
341 const char *buf, size_t sz);
342 YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream,
343 int fd, off_t start_offset);
344 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
346 ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh, zebra_rec_keys_t reckeys,
347 zebra_snippets *snippets);
348 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
349 zint sysno, zebra_snippets *snippets);
351 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
353 ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
356 ZEBRA_RES zebra_begin_read(ZebraHandle zh);
357 ZEBRA_RES zebra_end_read(ZebraHandle zh);
359 int zebra_file_stat(const char *file_name, struct stat *buf,
362 Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
363 int compact_flag, Res res);
365 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
366 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
368 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
369 char **dst, const char *src);
371 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
373 void zebra_term_untrans(ZebraHandle zh, int reg_type,
374 char *dst, const char *src);
376 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
377 Z_AttributesPlusTerm *zapt,
379 const char *xpath_use,
380 oid_value curAttributeSet,
383 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
384 Z_AttributeList *attr_list,
385 zinfo_index_category_t cat,
387 oid_value curAttributeSet,
390 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
391 Z_SortAttributes *sortAttributes,
395 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
396 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
397 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
398 ZEBRA_RES zebra_remove_file_match(ZebraHandle zh);
400 struct rpn_char_map_info
406 void rpn_char_map_prepare(struct zebra_register *reg, int reg_type,
407 struct rpn_char_map_info *map_info);
409 ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
413 int zebra_check_res(Res res);
415 #define FIRST_IN_FIELD_STR "\001^"
416 #define FIRST_IN_FIELD_CHAR 1
417 #define FIRST_IN_FIELD_LEN 2
425 * indent-tabs-mode: nil
427 * vim: shiftwidth=4 tabstop=8 expandtab