X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=index%2Frecindex.h;h=e087e27d6bdeac5ad208e995e27e22a23c569ae4;hb=8c1d8b5e863e1375f9e25c4e11c8443f11c22496;hp=b92bea78af92ca2d1f6389c6e96661d30059ca76;hpb=8fa59ec675af0ea4f15f157401c61121b5cb5782;p=idzebra-moved-to-github.git

diff --git a/index/recindex.h b/index/recindex.h
index b92bea7..e087e27 100644
--- a/index/recindex.h
+++ b/index/recindex.h
@@ -1,8 +1,5 @@
-/* $Id: recindex.h,v 1.32 2007-11-23 13:52:52 adam Exp $
-   Copyright (C) 1995-2007
-   Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+   Copyright (C) Index Data
 
 Zebra is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -79,28 +76,49 @@ Record rec_get(Records p, zint sysno);
     \returns record pointer (or NULL on error)
 */
 Record rec_get_root(Records p);
+
+
+/** \brief gets next record - with given records
+    \param p records handle
+    \param rec record
+    \returns record pointer (or NULL on error)
+*/
+Record rec_get_next(Records p, Record rec);
+
 ZEBRA_RES rec_close (Records *p);
 
 /** \brief opens records system
     \param bfs block file storage
     \param rw read-write flag(0=read only, 1=write)
-    \param compression_method REC_COMPRESS_ type 
+    \param compression_method REC_COMPRESS_ type
 */
 Records rec_open(BFiles bfs, int rw, int compression_method);
 
+/** \brief check whether a compression method is supported
+    \param compression_method (REC_COMPRESS_..)
+    \retval 0 if method is unsupported
+    \retval 1 if method is supported
+*/
+int rec_check_compression_method(int compression_method);
+
 char *rec_strdup(const char *s, size_t *len);
-void rec_prstat(Records p);
+void rec_prstat(Records p, int verbose);
 
 zint rec_sysno_to_int(zint sysno);
 
-/** \brief compression types */
+
+/** \brief No compression ("none") */
 #define REC_COMPRESS_NONE   0
+/** \brief BZIP2 compression (slow and requires big chunks) */
 #define REC_COMPRESS_BZIP2  1
+/** \brief zlib compression (faster and works off small chunks) */
+#define REC_COMPRESS_ZLIB   2
 
-enum { 
-    recInfo_fileType, 
-    recInfo_filename, 
-    recInfo_delKeys, 
+
+enum {
+    recInfo_fileType,
+    recInfo_filename,
+    recInfo_delKeys,
     recInfo_databaseName,
     recInfo_storeData,
     recInfo_attr,
@@ -109,12 +127,21 @@ enum {
 
 typedef struct recindex *recindex_t;
 
-recindex_t recindex_open(BFiles bfs, int rw);
+/** \brief opens record index handle
+    \param bfs Block files handle
+    \param rw 1 for read and write; 0 for read-only
+    \param use_isamb 1 if ISAMB is to used for record index; 0 for flat (old)
+*/
+recindex_t recindex_open(BFiles bfs, int rw, int use_isamb);
+
+/** \brief closes record index handle
+    \param p records handle
+*/
 void recindex_close(recindex_t p);
 int recindex_read_head(recindex_t p, void *buf);
 const char *recindex_get_fname(recindex_t p);
 ZEBRA_RES recindex_write_head(recindex_t p, const void *buf, size_t len);
-int recindex_read_indx(recindex_t p, zint sysno, void *buf, int itemsize, 
+int recindex_read_indx(recindex_t p, zint sysno, void *buf, int itemsize,
                        int ignoreError);
 void recindex_write_indx(recindex_t p, zint sysno, void *buf, int itemsize);
 
@@ -123,6 +150,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab