Happy new year
[idzebra-moved-to-github.git] / index / recindex.h
1 /* This file is part of the Zebra server.
2    Copyright (C) 1994-2009 Index Data
3
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18 */
19
20 #ifndef RECINDEX_H
21 #define RECINDEX_H
22
23 #include <idzebra/util.h>
24 #include <zebra-lock.h>
25 #include <idzebra/bfile.h>
26
27 YAZ_BEGIN_CDECL
28
29 #define REC_NO_INFO 8
30
31 typedef struct record_info {
32     zint sysno;
33     int newFlag;
34     char *info[REC_NO_INFO];
35     size_t size[REC_NO_INFO];
36     char buf_size[REC_NO_INFO][6];
37     size_t size_size[REC_NO_INFO];
38     Zebra_mutex mutex;
39 } *Record;
40
41 typedef struct records_info *Records;
42
43 /** \brief marks record for deletion (on file storage)
44     \param p records handle
45     \param recpp record pointer
46     \returns ZEBRA_OK / ZEBRA_FAIL
47 */
48 ZEBRA_RES rec_del(Records p, Record *recpp);
49
50 /** \brief frees record (from memory)
51     \param recpp record pointer
52 */
53 void rec_free(Record *recpp);
54
55 /** \brief puts record (writes into file storage)
56     \param p records handle
57     \param recpp record pointer
58     \returns ZEBRA_OK / ZEBRA_FAIL
59 */
60 ZEBRA_RES rec_put(Records p, Record *recpp);
61
62 /** \brief creates new record (to be written to file storage)
63     \param p records handle
64     \returns record pointer (or NULL on error)
65 */
66 Record rec_new(Records p);
67 /** \brief gets record - with given system number
68     \param p records handle
69     \param sysno system ID (external number)
70     \returns record pointer (or NULL on error)
71 */
72 Record rec_get(Records p, zint sysno);
73
74 /** \brief gets root record
75     \param p records handle
76     \returns record pointer (or NULL on error)
77 */
78 Record rec_get_root(Records p);
79 ZEBRA_RES rec_close (Records *p);
80
81 /** \brief opens records system
82     \param bfs block file storage
83     \param rw read-write flag(0=read only, 1=write)
84     \param compression_method REC_COMPRESS_ type 
85 */
86 Records rec_open(BFiles bfs, int rw, int compression_method);
87
88 char *rec_strdup(const char *s, size_t *len);
89 void rec_prstat(Records p, int verbose);
90
91 zint rec_sysno_to_int(zint sysno);
92
93 /** \brief compression types */
94 #define REC_COMPRESS_NONE   0
95 #define REC_COMPRESS_BZIP2  1
96
97 enum { 
98     recInfo_fileType, 
99     recInfo_filename, 
100     recInfo_delKeys, 
101     recInfo_databaseName,
102     recInfo_storeData,
103     recInfo_attr,
104     recInfo_sortKeys
105 };
106
107 typedef struct recindex *recindex_t;
108
109 /** \brief opens record index handle
110     \param bfs Block files handle
111     \param rw 1 for read and write; 0 for read-only
112     \param use_isamb 1 if ISAMB is to used for record index; 0 for flat (old)
113 */
114 recindex_t recindex_open(BFiles bfs, int rw, int use_isamb);
115
116 /** \brief closes record index handle
117     \param p records handle
118 */
119 void recindex_close(recindex_t p);
120 int recindex_read_head(recindex_t p, void *buf);
121 const char *recindex_get_fname(recindex_t p);
122 ZEBRA_RES recindex_write_head(recindex_t p, const void *buf, size_t len);
123 int recindex_read_indx(recindex_t p, zint sysno, void *buf, int itemsize, 
124                        int ignoreError);
125 void recindex_write_indx(recindex_t p, zint sysno, void *buf, int itemsize);
126
127 YAZ_END_CDECL
128 #endif
129 /*
130  * Local variables:
131  * c-basic-offset: 4
132  * indent-tabs-mode: nil
133  * End:
134  * vim: shiftwidth=4 tabstop=8 expandtab
135  */
136