summaryrefslogtreecommitdiffstats
path: root/src/partition/jsondbpartition.h
blob: 6df8f9a8da56c93d04c526c5dfd617fe6db7b528 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtAddOn.JsonDb module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef JSONDB_PARTITION_H
#define JSONDB_PARTITION_H

#include <QStringList>
#include <QSet>
#include <QPointer>

#include "jsondbpartitionglobal.h"
#include "jsondberrors.h"
#include "jsondbobjectkey.h"
#include "jsondbnotification.h"
#include "jsondbowner.h"
#include "jsondbpartitionspec.h"
#include "jsondbstat.h"
#include "jsondbschemamanager_p.h"

QT_BEGIN_HEADER

class TestJsonDb;

QT_BEGIN_NAMESPACE_JSONDB_PARTITION

class JsonDbOwner;
class JsonDbObjectTable;
class JsonDbIndex;
class JsonDbView;

struct Q_JSONDB_PARTITION_EXPORT JsonDbUpdate {
    JsonDbUpdate(const JsonDbObject &oldObj, const JsonDbObject &newObj, JsonDbNotification::Action act) :
        oldObject(oldObj), newObject(newObj), action(act) { }
    JsonDbUpdate() : action(JsonDbNotification::None) {}
    JsonDbObject oldObject;
    JsonDbObject newObject;
    JsonDbNotification::Action action;
};


typedef QList<JsonDbUpdate> JsonDbUpdateList;
struct Q_JSONDB_PARTITION_EXPORT JsonDbWriteResult {
    JsonDbWriteResult() : state(0), code(JsonDbError::NoError) { }
    JsonDbObjectList objectsWritten;
    quint32 state;
    JsonDbError::ErrorCode code;
    QString message;
};

struct Q_JSONDB_PARTITION_EXPORT JsonDbChangesSinceResult {
    JsonDbChangesSinceResult() : currentStateNumber(0), startingStateNumber(0), code(JsonDbError::NoError) { }
    quint32 currentStateNumber;
    quint32 startingStateNumber;
    JsonDbUpdateList changes;
    JsonDbError::ErrorCode code;
    QString message;
};

typedef QList<JsonDbObject> JsonDbObjectList;
struct Q_JSONDB_PARTITION_EXPORT JsonDbQueryResult {
    JsonDbQueryResult() : offset(0), state(0), code(JsonDbError::NoError), objectTable(0) { }
    JsonDbObjectList data;
    int offset;
    quint32 state;
    QStringList sortKeys;
    JsonDbError::ErrorCode code;
    QString message;
    JsonDbObjectTable *objectTable;
};

class JsonDbPartitionPrivate;
class Q_JSONDB_PARTITION_EXPORT JsonDbPartition : public QObject
{
    Q_OBJECT
public:
    enum ConflictResolutionMode {
        RejectStale,    // write must not introduce a conflict
        Replace,        // accept write as is (almost no matter what)
        ReplicatedWrite,    // master/master replication, may create obj._meta.conflicts
        ViewObject          // internal for view object
    };

    enum DiskSpaceStatus {
        UnknownStatus,  // Unknown, this happens between construction and open
        HasSpace,         // Available space >= minimum required
        OutOfSpace      // Available space < minimum required
    };

    enum TxnCommitResult {
        TxnSucceeded,      // Everything ok
        TxnOutOfSpace,     // Not enough space to write to disk
        TxnStorageError    // Problems with the storage system
    };

    JsonDbPartition(QObject *parent = 0);
    ~JsonDbPartition();

    void setPartitionSpec(const JsonDbPartitionSpec &spec);
    const JsonDbPartitionSpec &partitionSpec() const;

    void setDefaultOwner(JsonDbOwner *owner);
    JsonDbOwner *defaultOwner() const;

    QString filename() const;
    bool open();
    bool close();
    bool isOpen() const;

    bool clear();
    void closeIndexes();
    void flushCaches();
    bool compact();

    JsonDbQueryResult queryObjects(const JsonDbOwner *owner, const JsonDbQuery &query, int limit = -1, int offset = 0);
    JsonDbWriteResult updateObjects(const JsonDbOwner *owner, const JsonDbObjectList &objects, ConflictResolutionMode mode = RejectStale, JsonDbUpdateList *changeList = 0);
    JsonDbWriteResult updateObject(const JsonDbOwner *owner, const JsonDbObject &object, ConflictResolutionMode mode = RejectStale, JsonDbUpdateList *changeList = 0);
    JsonDbChangesSinceResult changesSince(quint32 stateNumber, const QSet<QString> &limitTypes = QSet<QString>());
    int flush(bool *ok);

    void addNotification(JsonDbNotification *notification);
    void removeNotification(JsonDbNotification *notification);

    JsonDbObjectTable *mainObjectTable() const;
    JsonDbObjectTable *findObjectTable(const QString &objectType) const;
    JsonDbView *findView(const QString &objectType) const;

    JsonDbStat stat() const;
    QHash<QString, qint64> fileSizes() const;

public Q_SLOTS:
    void updateView(const QString &objectType, quint32 stateNumber=0);

private:
    Q_DECLARE_PRIVATE(JsonDbPartition)
    Q_DISABLE_COPY(JsonDbPartition)
    Q_PRIVATE_SLOT(d_func(), void _q_mainSyncTimer())
    Q_PRIVATE_SLOT(d_func(), void _q_indexSyncTimer())
    Q_PRIVATE_SLOT(d_func(), void _q_objectsUpdated(bool,JsonDbUpdateList))
    QScopedPointer<JsonDbPartitionPrivate> d_ptr;

    friend class JsonDbIndexQuery;
    friend class JsonDbObjectTable;
    friend class JsonDbOwner;
    friend class JsonDbQuery;
    friend class JsonDbMapDefinition;
    friend class JsonDbReduceDefinition;
    friend class JsonDbView;

    friend class ::TestPartition;
    friend class ::TestJsonDb;
};

QT_END_NAMESPACE_JSONDB_PARTITION

QT_END_HEADER

#endif // JSONDB_PARTITION_H