Remove append-only btree
[qt:qtjsondb.git] / src / partition / jsondbbtree.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtAddOn.JsonDb module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef JSONDB_BTREE_H
43 #define JSONDB_BTREE_H
44
45 #define JSONDB_USE_HBTREE
46
47 #include "jsondbpartitionglobal.h"
48
49 #include "hbtree.h"
50 #include "hbtreecursor.h"
51 #include "hbtreetransaction.h"
52
53 QT_BEGIN_HEADER
54
55 QT_BEGIN_NAMESPACE_JSONDB_PARTITION
56
57 class JsonDbBtree
58 {
59 public:
60
61     enum OpenFlag {
62         Default,
63         ReadOnly
64     };
65     Q_DECLARE_FLAGS(OpenFlags, OpenFlag)
66
67     typedef HBtree Btree;
68
69     typedef Btree::CursorType Cursor;
70     typedef Btree::TransactionType Transaction;
71     typedef Btree::StatType Stat;
72
73     typedef int (*CompareFunction)(const QByteArray &, const QByteArray &);
74
75     JsonDbBtree();
76     ~JsonDbBtree();
77
78     void setFileName(const QString &filename);
79     QString fileName() const;
80
81     bool open(OpenFlags flags = Default);
82     void close();
83     bool isOpen() const;
84
85     Transaction *beginRead()
86     { Q_ASSERT(mBtree); return mBtree->beginRead(); }
87     Transaction *beginWrite()
88     { Q_ASSERT(mBtree); return mBtree->beginWrite(); }
89
90     bool isWriting() const
91     { Q_ASSERT(mBtree); return mBtree->isWriting(); }
92
93     Transaction *writeTransaction()
94     { Q_ASSERT(mBtree); return mBtree->writeTransaction(); }
95
96     QString errorMessage() const
97     { Q_ASSERT(mBtree); return mBtree->errorMessage(); }
98
99     quint64 count() const
100     { Q_ASSERT(mBtree); return mBtree->count(); }
101     quint32 tag() const
102     { Q_ASSERT(mBtree); return mBtree->tag(); }
103     void setCompareFunction(CompareFunction cmp)
104     { Q_ASSERT(mBtree); mBtree->setCompareFunction(cmp); }
105     void setCacheSize(int size)
106     { Q_ASSERT(mBtree); mBtree->setCacheSize(size); }
107     Btree *btree() const
108     { return mBtree; }
109     Stat stats() const;
110     bool sync()
111     { Q_ASSERT(mBtree); return mBtree->sync(); }
112     int lastWriteError() const
113     { Q_ASSERT(mBtree); return mBtree->lastWriteError(); }
114     int lastReadError() const
115     { Q_ASSERT(mBtree); return mBtree->lastReadError(); }
116
117     bool putOne(const QByteArray &key, const QByteArray &value);
118     bool getOne(const QByteArray &key, QByteArray *value);
119     bool removeOne(const QByteArray &key);
120
121     bool clearData();
122
123     bool compact();
124     bool rollback();
125     void setAutoCompactRate(int rate) const;
126
127 private:
128     Btree *mBtree;
129     JsonDbBtree(const JsonDbBtree&);
130 };
131
132 Q_DECLARE_OPERATORS_FOR_FLAGS(JsonDbBtree::OpenFlags)
133
134 QT_END_NAMESPACE_JSONDB_PARTITION
135
136 QT_END_HEADER
137
138 #endif // JSONDB_BTREE_H