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