Implemented update action : adelete.
[idzebra-moved-to-github.git] / index / index.h
index 4997cfd..6b1848f 100644 (file)
@@ -1,5 +1,5 @@
-/* $Id: index.h,v 1.179 2006-10-12 12:28:42 adam Exp $
-   Copyright (C) 1995-2006
+/* $Id: index.h,v 1.214 2007-12-20 11:15:42 adam Exp $
+   Copyright (C) 1995-2007
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -20,8 +20,8 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 */
 
-#ifndef INDEX_H
-#define INDEX_H
+#ifndef ZEBRA_INDEX_H
+#define ZEBRA_INDEX_H
 
 #include <time.h>
 #include <stdlib.h>
@@ -29,12 +29,12 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <idzebra/util.h>
 #include <idzebra/flock.h>
 #include <sortidx.h>
-
 #if HAVE_SYS_TIMES_H
 #include <sys/times.h>
 #endif
 #include <sys/stat.h>
 
+#include <yaz/timing.h>
 #include <idzebra/dict.h>
 #include <idzebra/isams.h>
 #include <idzebra/isamc.h>
@@ -48,20 +48,13 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include <rset.h>
 #include <zebramap.h>
 
+#include <it_key.h>
+#include <su_codec.h>
+
 YAZ_BEGIN_CDECL
 
 #define ISAM_DEFAULT "b"
 
-#define SU_SCHEME 1
-
-#define IT_MAX_WORD 256
-
-#define IT_KEY_LEVEL_MAX 5
-struct it_key {
-    int  len;
-    zint mem[IT_KEY_LEVEL_MAX];
-};
-
 enum dirsKind { dirs_dir, dirs_file };
 
 struct dir_entry {
@@ -73,83 +66,54 @@ struct dir_entry {
 struct dirs_entry {
     enum dirsKind kind;
     char path[256];
-    SYSNO sysno;
+    zint sysno;
     time_t mtime;
 };
 
-void getFnameTmp (Res res, char *fname, int no);
+void getFnameTmp(Res res, char *fname, int no);
         
-struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
-struct dirs_info *dirs_fopen (Dict dict, const char *path, int rw);
-struct dirs_entry *dirs_read (struct dirs_info *p);
-struct dirs_entry *dirs_last (struct dirs_info *p);
-void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
-void dirs_rmdir (struct dirs_info *p, const char *src);
-void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
-void dirs_del (struct dirs_info *p, const char *src);
-void dirs_free (struct dirs_info **pp);
-
-struct dir_entry *dir_open (const char *rep, const char *base,
-                            int follow_links);
-void dir_sort (struct dir_entry *e);
-void dir_free (struct dir_entry **e_p);
-
-void repositoryUpdate (ZebraHandle zh, const char *path);
-void repositoryAdd (ZebraHandle zh, const char *path);
-void repositoryDelete (ZebraHandle zh, const char *path);
-void repositoryShow (ZebraHandle zh, const char *path);
-
-int key_open (ZebraHandle zh, int mem);
-int key_close (ZebraHandle zh);
-int key_compare (const void *p1, const void *p2);
-void key_init(struct it_key *k);
-char *key_print_it (const void *p, char *buf);
-zint key_get_seq (const void *p);
-zint key_get_segment (const void *p);
-int key_compare_it (const void *p1, const void *p2);
-int key_qsort_compare (const void *p1, const void *p2);
-void key_logdump (int mask, const void *p);
-void key_logdump_txt (int logmask, const void *p, const char *txt);
-void inv_prstat (ZebraHandle zh);
-void inv_compact (BFiles bfs);
-void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
-ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
-ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
-int merge_sort (char **buf, int from, int to);
-int key_SU_code (int ch, char *out);
+struct dirs_info *dirs_open(Dict dict, const char *rep, int rw);
+struct dirs_info *dirs_fopen(Dict dict, const char *path, int rw);
+struct dirs_entry *dirs_read(struct dirs_info *p);
+struct dirs_entry *dirs_last(struct dirs_info *p);
+void dirs_mkdir(struct dirs_info *p, const char *src, time_t mtime);
+void dirs_rmdir(struct dirs_info *p, const char *src);
+void dirs_add(struct dirs_info *p, const char *src, zint sysno, time_t mtime);
+void dirs_del(struct dirs_info *p, const char *src);
+void dirs_free(struct dirs_info **pp);
+
+struct dir_entry *dir_open(const char *rep, const char *base,
+                           int follow_links);
+void dir_sort(struct dir_entry *e);
+void dir_free(struct dir_entry **e_p);
+
+void repositoryUpdate(ZebraHandle zh, const char *path);
+void repositoryAdd(ZebraHandle zh, const char *path);
+void repositoryDelete(ZebraHandle zh, const char *path);
+void repositoryShow(ZebraHandle zh, const char *path);
+
+void inv_prstat(ZebraHandle zh);
+void inv_compact(BFiles bfs);
+void key_input(ZebraHandle zh, int nkeys, int cache, Res res);
+ISAMS_M *key_isams_m(Res res, ISAMS_M *me);
+ISAMC_M *key_isamc_m(Res res, ISAMC_M *me);
 
 #define FNAME_DICT "dict"
 #define FNAME_ISAM "isam"
 #define FNAME_ISAMC "isamc"
 #define FNAME_ISAMS "isams"
-#define FNAME_ISAMH "isamh"
-#define FNAME_ISAMD "isamd"
 #define FNAME_CONFIG "zebra.cfg"
 
 #define GMATCH_DICT "gmatch"
 #define FMATCH_DICT "fmatch%d"
 
-struct strtab *strtab_mk (void);
-int strtab_src (struct strtab *t, const char *name, void ***infop);
-void strtab_del (struct strtab *t,
-                 void (*func)(const char *name, void *info, void *data),
-                 void *data);
-
-void zebraIndexLockMsg (ZebraHandle zh, const char *str);
-void zebraIndexUnlock (ZebraHandle zh);
-int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
-int zebraIndexWait (ZebraHandle zh, int commitPhase);
-
-void zebra_lock_prefix (Res res, char *dst);
+void zebra_lock_prefix(Res res, char *dst);
 
 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 #define FNAME_TOUCH_TIME  "zebraidx.time"
 
-int key_SU_decode (int *ch, const unsigned char *out);
-int key_SU_encode (int ch, char *out);
-
 typedef struct zebra_set *ZebraSet;
 
 typedef struct zebra_rank_class {
@@ -160,6 +124,7 @@ typedef struct zebra_rank_class {
 } *ZebraRankClass;
 
 #include "reckeys.h"
+#include "key_block.h"
 
 struct zebra_register {
     char *name;
@@ -169,7 +134,7 @@ struct zebra_register {
     ISAMB isamb;
     Dict dict;
     Dict matchDict;
-    SortIdx sortIdx;
+    zebra_sort_index_t sort_index;
     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
     time_t registerChange;
     BFiles bfs;
@@ -178,7 +143,7 @@ struct zebra_register {
 
     char *server_path_prefix;
     data1_handle dh;
-    ZebraMaps zebra_maps;
+    zebra_maps_t zebra_maps;
     ZebraRankClass rank_classes;
     RecTypes recTypes;
     int seqno;
@@ -187,11 +152,8 @@ struct zebra_register {
 
     zebra_rec_keys_t keys;
     zebra_rec_keys_t sortKeys;
-    char **key_buf;
-    size_t ptr_top;
-    size_t ptr_i;
-    size_t key_buf_used;
-    int key_file_no;
+
+    zebra_key_block_t key_block;
 };
 
 struct zebra_service {
@@ -205,6 +167,7 @@ struct zebra_service {
     const char *path_root;
     RecTypeClass record_classes;
     NMEM nmem;
+    yaz_timing_t timing;
 };
 
 
@@ -234,8 +197,8 @@ struct zebra_session {
     char *user_perm;
     char *dbaccesslist;
     int errCode;
-    zint hits;
     char *errString;
+    int partial_result;
 #if HAVE_SYS_TIMES_H
     struct tms tms1;
     struct tms tms2;    
@@ -249,6 +212,7 @@ struct zebra_session {
     zint records_updated;
     zint records_deleted;
     zint records_processed;
+    zint records_skipped;
     char *record_encoding;
 
     yaz_iconv_t iconv_to_utf8;
@@ -269,6 +233,9 @@ struct zebra_session {
     NMEM nmem_error;
 
     struct zebra_limit *m_limit;
+
+    int (*break_handler_func)(void *client_data);
+    void *break_handler_data;
 };
 
 
@@ -293,98 +260,94 @@ void zebra_limit_for_rset(struct zebra_limit *zl,
 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 
 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
-                        oid_value attributeSet, 
+                        const Odr_oid *attributeSet, 
                         NMEM stream, NMEM rset_nmem,
                         Z_SortKeySpecList *sort_sequence,
-                        int num_bases, char **basenames,
+                        int num_bases, const char **basenames,
                         RSET *result_set);
 
+ZEBRA_RES rpn_get_top_approx_limit(ZebraHandle zh, Z_RPNStructure *zs,
+                                   zint *approx_limit);
+
 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
-                   oid_value attributeset,
+                   const Odr_oid *attributeset,
                    int num_bases, char **basenames,
                    int *position, int *num_entries, ZebraScanEntry **list,
-                   int *is_partial, RSET limit_set);
+                   int *is_partial, const char *set_name);
 
 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
                const char *term, int length_term, const char *flags,
                int preserve_position, int term_type, NMEM rset_nmem,
                struct rset_key_control *kctrl, int scope,
-               struct ord_list *ol, int reg_type,
+               struct ord_list *ol, const char *index_type,
                zint hits_limit, const char *term_ref_id);
 
+ZEBRA_RES resultSetGetBaseNames(ZebraHandle zh, const char *setname,
+                                const char ***basenames, int *num_bases);
+
 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
                       const char *db, const char *index_name,
                       const char *term);
-ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
-ZebraSet resultSetGet (ZebraHandle zh, const char *name);
-ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
-                    int num_bases, char **basenames,
-                    const char *setname);
-RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
-void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
+ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov);
+ZebraSet resultSetGet(ZebraHandle zh, const char *name);
+ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
+                          int num_bases, char **basenames,
+                          const char *setname,
+                          zint *hits, int *estimated_hit_count);
+RSET resultSetRef(ZebraHandle zh, const char *resultSetId);
+void resultSetDestroy(ZebraHandle zh, int num_names, char **names,
                       int *statuses);
-ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
+ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
                         int num_input_setnames, const char **input_setnames,
                         const char *output_setname,
                         Z_SortKeySpecList *sort_sequence, int *sort_status);
-ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
+ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
                               ZebraSet sset, RSET rset,
                               Z_SortKeySpecList *sort_sequence,
                               int *sort_status);
-ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
+ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet, RSET rset,
                         NMEM nmem);
-void resultSetInvalidate (ZebraHandle zh);
+void resultSetInvalidate(ZebraHandle zh);
 
-int zebra_server_lock_init (ZebraService zh);
-int zebra_server_lock_destroy (ZebraService zh);
-int zebra_server_lock (ZebraService zh, int lockCommit);
-void zebra_server_unlock (ZebraService zh, int commitPhase);
-int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
+int zebra_record_fetch(ZebraHandle zh, const char *setname,
+                       zint sysno, int score, 
+                       ODR stream,
+                       const Odr_oid *input_format, Z_RecordComposition *comp,
+                       const Odr_oid **output_format, char **rec_bufp,
+                       int *rec_lenp, char **basenamep,
+                       char **addinfo);
 
-int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, 
-                       zebra_snippets *hit_snippet, ODR stream,
-                       oid_value input_format, Z_RecordComposition *comp,
-                       oid_value *output_format, char **rec_bufp,
-                       int *rec_lenp, char **basenamep,
-                       char **addinfo);
+void extract_get_fname_tmp(ZebraHandle zh, char *fname, int no);
 
-void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
+void extract_snippet(ZebraHandle zh, zebra_snippets *sn,
+                     struct ZebraRecStream *stream, RecType rt,
+                     void *recTypeClientData);
 
-void zebra_index_merge (ZebraHandle zh);
+int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
+                           zebra_snippets *snippets);
+
+void zebra_index_merge(ZebraHandle zh);
 
 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh, 
                                       const char *buf, size_t buf_size,
-                                      int delete_flag,
+                                      enum zebra_recctrl_action_t action,
                                       int test_mode, 
                                       const char *recordType,
-                                      SYSNO *sysno,
+                                      zint *sysno,
                                       const char *match_criteria,
-                                      const char *fname,
-                                      int force_update,
-                                      int allow_update);
+                                      const char *fname);
 
 ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh, 
                                       struct ZebraRecStream *stream,
-                                      int delete_flag,
+                                      enum zebra_recctrl_action_t action,
                                       int test_mode, 
                                       const char *recordType,
-                                      SYSNO *sysno,
+                                      zint *sysno,
                                       const char *match_criteria,
                                       const char *fname,
-                                      int force_update,
-                                      int allow_update,
                                       RecType recType,
-                                      void *recTypeClientData);
-
-#if 0
-int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
-                        const char *buf, size_t buf_size,
-                        const char *databaseName, int delete_flag,
-                        int test_mode, int *sysno,
-                        int store_keys, int store_data,
-                        const char *match_criteria);
-#endif
-void extract_flushWriteKeys (ZebraHandle zh, int final);
+                                      void *recTypeClientData,
+                                      int *more);
 
 YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream,
                                         const char *buf, size_t sz);
@@ -392,56 +355,49 @@ YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream,
                                        int fd, off_t start_offset);
 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
 
-ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys,
-                                 zebra_snippets *snippets);
+ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh, zebra_rec_keys_t reckeys,
+                                     zebra_snippets *snippets);
 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
                                    zint sysno, zebra_snippets *snippets);
 
 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
 
-ZEBRA_RES zebra_extract_file(ZebraHandle zh, SYSNO *sysno, const char *fname,
-                            int deleteFlag);
+ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
+                             enum zebra_recctrl_action_t action);
 
-ZEBRA_RES zebra_begin_read (ZebraHandle zh);
-ZEBRA_RES zebra_end_read (ZebraHandle zh);
+ZEBRA_RES zebra_begin_read(ZebraHandle zh);
+ZEBRA_RES zebra_end_read(ZebraHandle zh);
 
-int zebra_file_stat (const char *file_name, struct stat *buf,
+int zebra_file_stat(const char *file_name, struct stat *buf,
                      int follow_links);
 
-void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
-
-void *iscz1_start ();
-void iscz1_reset (void *vp);
-void iscz1_stop (void *p);
-void iscz1_decode (void *vp, char **dst, const char **src);
-void iscz1_encode (void *vp, char **dst, const char **src);
-
-Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
-                   int compact_flag, Res res);
+Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
+                   int compact_flag, Res res);
 
 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 
-void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
-                             char **dst, const char *src);
+int zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, 
+                             const char *index_type,
+                             char **dst, const char *src);
 
 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 
-void zebra_term_untrans(ZebraHandle zh, int reg_type,
-                       char *dst, const char *src);
+int zebra_term_untrans(ZebraHandle zh, const char *index_type,
+                       char *dst, const char *src);
 
 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
                             Z_AttributesPlusTerm *zapt,
-                            int index_type,
+                            const char *index_type,
                             const char *xpath_use,
-                            oid_value curAttributeSet,
+                            const Odr_oid *curAttributeSet,
                             int *ord);
 
 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
                                   Z_AttributeList *attr_list,
                                   zinfo_index_category_t cat,
-                                  int index_type,
-                                  oid_value curAttributeSet,
+                                  const char *index_type,
+                                  const Odr_oid *curAttributeSet,
                                   int *ord);
 
 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
@@ -450,28 +406,49 @@ ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
                              int *numerical);
 
 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
-ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
-ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
+ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path,
+                                 enum zebra_recctrl_action_t action);
 ZEBRA_RES zebra_remove_file_match(ZebraHandle zh);
 
-
 struct rpn_char_map_info
 {
-    ZebraMaps zm;
+    zebra_map_t zm;
     int reg_type;
 };
 
-void rpn_char_map_prepare(struct zebra_register *reg, int reg_type,
+void rpn_char_map_prepare(struct zebra_register *reg, zebra_map_t zm,
                           struct rpn_char_map_info *map_info);
 
 ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
                            char *termz);
 
 
+void zebra_set_partial_result(ZebraHandle zh);
+
+int zebra_check_res(Res res);
+
 #define FIRST_IN_FIELD_STR "\001^"
 #define FIRST_IN_FIELD_CHAR 1
 #define FIRST_IN_FIELD_LEN 2
 
+ZEBRA_RES zebra_term_limits_APT(ZebraHandle zh,
+                                Z_AttributesPlusTerm *zapt,
+                                zint *hits_limit_value,
+                                const char **term_ref_id_str,
+                                NMEM nmem);
+
+ZEBRA_RES zebra_result_recid_to_sysno(ZebraHandle zh, 
+                                      const char *setname,
+                                      zint recid,
+                                      zint *sysnos, int *no_sysnos);
+
+void zebra_count_set(ZebraHandle zh, RSET rset, zint *count,
+                     zint approx_limit);
+
+RSET zebra_create_rset_isam(ZebraHandle zh,
+                            NMEM rset_nmem, struct rset_key_control *kctl,
+                            int scope, ISAM_P pos, TERMID termid);
+
 YAZ_END_CDECL
 
 #endif