31ae460e267aeb9a5eadbc803c2bf77a3dc72feb
[idzebra-moved-to-github.git] / index / recindex.h
1 /*
2  * Copyright (C) 1994-1999, Index Data
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: recindex.h,v $
7  * Revision 1.17  1999-07-06 12:28:04  adam
8  * Updated record index structure. Format includes version ID. Compression
9  * algorithm ID is stored for each record block.
10  *
11  * Revision 1.16  1999/06/25 13:48:02  adam
12  * Updated MSVC project files.
13  * Added BZIP2 record compression (not very well tested).
14  *
15  * Revision 1.15  1999/05/26 07:49:13  adam
16  * C++ compilation.
17  *
18  * Revision 1.14  1999/02/02 14:51:04  adam
19  * Updated WIN32 code specific sections. Changed header.
20  *
21  * Revision 1.13  1998/03/05 08:45:12  adam
22  * New result set model and modular ranking system. Moved towards
23  * descent server API. System information stored as "SGML" records.
24  *
25  * Revision 1.12  1998/01/12 15:04:08  adam
26  * The test option (-s) only uses read-lock (and not write lock).
27  *
28  * Revision 1.11  1997/09/17 12:19:16  adam
29  * Zebra version corresponds to YAZ version 1.4.
30  * Changed Zebra server so that it doesn't depend on global common_resource.
31  *
32  * Revision 1.10  1996/10/29 14:06:53  adam
33  * Include zebrautl.h instead of alexutil.h.
34  *
35  * Revision 1.9  1996/05/01 13:46:36  adam
36  * First work on multiple records in one file.
37  * New option, -offset, to the "unread" command in the filter module.
38  *
39  * Revision 1.8  1995/12/06  12:41:25  adam
40  * New command 'stat' for the index program.
41  * Filenames can be read from stdin by specifying '-'.
42  * Bug fix/enhancement of the transformation from terms to regular
43  * expressons in the search engine.
44  *
45  * Revision 1.7  1995/11/28  09:09:45  adam
46  * Zebra config renamed.
47  * Use setting 'recordId' to identify record now.
48  * Bug fix in recindex.c: rec_release_blocks was invokeded even
49  * though the blocks were already released.
50  * File traversal properly deletes records when needed.
51  *
52  * Revision 1.6  1995/11/27  09:56:21  adam
53  * Record info elements better enumerated. Internal store of records.
54  *
55  * Revision 1.5  1995/11/25  10:24:07  adam
56  * More record fields - they are enumerated now.
57  * New options: flagStoreData flagStoreKey.
58  *
59  * Revision 1.4  1995/11/22  17:19:19  adam
60  * Record management uses the bfile system.
61  *
62  * Revision 1.3  1995/11/20  16:59:46  adam
63  * New update method: the 'old' keys are saved for each records.
64  *
65  * Revision 1.2  1995/11/15  19:13:08  adam
66  * Work on record management.
67  *
68  * Revision 1.1  1995/11/15  14:46:21  adam
69  * Started work on better record management system.
70  *
71  */
72
73 #include <zebrautl.h>
74 #include <bfile.h>
75
76 #ifdef __cplusplus
77 extern "C" {
78 #endif
79
80 #define REC_NO_INFO 8
81
82 typedef struct record_info {
83     int sysno;
84     int newFlag;
85     char *info[REC_NO_INFO];
86     size_t size[REC_NO_INFO];
87     char buf_size[REC_NO_INFO][6];
88     size_t size_size[REC_NO_INFO];
89 } *Record;
90
91 typedef struct records_info *Records;
92
93 Record rec_cp (Record rec);
94 void rec_del (Records p, Record *recpp);
95 void rec_rm (Record *recpp);
96 void rec_put (Records p, Record *recpp);
97 Record rec_new (Records p);
98 Record rec_get (Records p, int sysno);
99 void rec_close (Records *p);
100 Records rec_open (BFiles bfs, int rw, int compression_method);
101 char *rec_strdup (const char *s, size_t *len);
102 void rec_prstat (Records p);
103
104 #define REC_COMPRESS_NONE   0
105 #define REC_COMPRESS_BZIP2  1
106
107 enum { 
108     recInfo_fileType, 
109     recInfo_filename, 
110     recInfo_delKeys, 
111     recInfo_databaseName,
112     recInfo_storeData,
113     recInfo_attr
114 };
115
116 #ifdef __cplusplus
117 }
118 #endif