Work on new API. Locking system re-implemented
[idzebra-moved-to-github.git] / index / zinfo.h
1 /*
2  * Copyright (C) 1994-1999, Index Data
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: zinfo.h,v $
7  * Revision 1.12  2002-02-20 17:30:01  adam
8  * Work on new API. Locking system re-implemented
9  *
10  * Revision 1.11  2001/10/15 19:53:43  adam
11  * POSIX thread updates. First work on term sets.
12  *
13  * Revision 1.10  2000/05/15 12:56:37  adam
14  * Record offset of size off_t.
15  *
16  * Revision 1.9  2000/03/20 19:08:36  adam
17  * Added remote record import using Z39.50 extended services and Segment
18  * Requests.
19  *
20  * Revision 1.8  1999/11/30 13:48:03  adam
21  * Improved installation. Updated for inclusion of YAZ header files.
22  *
23  * Revision 1.7  1999/05/26 07:49:13  adam
24  * C++ compilation.
25  *
26  * Revision 1.6  1999/02/02 14:51:12  adam
27  * Updated WIN32 code specific sections. Changed header.
28  *
29  * Revision 1.5  1998/06/08 14:43:16  adam
30  * Added suport for EXPLAIN Proxy servers - added settings databasePath
31  * and explainDatabase to facilitate this. Increased maximum number
32  * of databases and attributes in one register.
33  *
34  * Revision 1.4  1998/05/20 10:12:21  adam
35  * Implemented automatic EXPLAIN database maintenance.
36  * Modified Zebra to work with ASN.1 compiled version of YAZ.
37  *
38  * Revision 1.3  1998/03/05 08:45:13  adam
39  * New result set model and modular ranking system. Moved towards
40  * descent server API. System information stored as "SGML" records.
41  *
42  * Revision 1.2  1996/05/22 08:22:00  adam
43  * Added public ZebDatabaseInfo structure.
44  *
45  * Revision 1.1  1996/05/13 14:23:07  adam
46  * Work on compaction of set/use bytes in dictionary.
47  *
48  */
49 #ifndef ZINFO_H
50 #define ZINFO_H
51
52 #include <yaz/data1.h>
53 #include "zebraapi.h"
54 #include "recindex.h"
55
56 YAZ_BEGIN_CDECL
57
58 typedef struct zebraExplainInfo *ZebraExplainInfo;
59 typedef struct zebDatabaseInfo ZebDatabaseInfo;
60 ZebraExplainInfo zebraExplain_open (Records records, data1_handle dh,
61                                     Res res,
62                                     int writeFlag,
63                                     void *updateHandle,
64                                     int (*updateFunc)(void *handle,
65                                                       Record drec,
66                                                       data1_node *n));
67 void zebraExplain_close (ZebraExplainInfo zei, int writeFlag /*,
68                                                                int (*updateH)(Record drec, data1_node *n)*/);
69 int zebraExplain_curDatabase (ZebraExplainInfo zei, const char *database);
70 int zebraExplain_newDatabase (ZebraExplainInfo zei, const char *database,
71                               int explain_database);
72 int zebraExplain_lookupSU (ZebraExplainInfo zei, int set, int use);
73 int zebraExplain_addSU (ZebraExplainInfo zei, int set, int use);
74 void zebraExplain_addSchema (ZebraExplainInfo zei, Odr_oid *oid);
75 void zebraExplain_recordCountIncrement (ZebraExplainInfo zei, int adjust_num);
76 void zebraExplain_recordBytesIncrement (ZebraExplainInfo zei, int adjust_num);
77 int zebraExplain_runNumberIncrement (ZebraExplainInfo zei, int adjust_num);
78 void zebraExplain_loadAttsets (data1_handle dh, Res res);
79 void zebraExplain_flush (ZebraExplainInfo zei, int writeFlag,
80                          void *updateHandle);
81
82 int zebraExplain_lookup_ord (ZebraExplainInfo zei, int ord,
83                              const char **db, int *set, int *use);
84
85 typedef struct {
86     int recordSize;
87     off_t recordOffset;
88     int runNumber;
89 } RecordAttr;
90 RecordAttr *rec_init_attr (ZebraExplainInfo zei, Record rec);
91
92 YAZ_END_CDECL
93
94 #endif