IndexedDB 2.0: Prefetch cursor records in the server.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / SQLiteIDBCursor.h
1 /*
2  * Copyright (C) 2014, 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBCursorRecord.h"
31 #include "IDBIndexInfo.h"
32 #include "IDBKeyData.h"
33 #include "IDBKeyRangeData.h"
34 #include "IDBResourceIdentifier.h"
35 #include "IDBValue.h"
36 #include "SQLiteStatement.h"
37 #include <wtf/Deque.h>
38 #include <wtf/Noncopyable.h>
39
40 namespace WebCore {
41
42 class IDBCursorInfo;
43 class IDBGetResult;
44
45 namespace IDBServer {
46
47 class SQLiteIDBTransaction;
48
49 class SQLiteIDBCursor {
50     WTF_MAKE_NONCOPYABLE(SQLiteIDBCursor);
51 public:
52     static std::unique_ptr<SQLiteIDBCursor> maybeCreate(SQLiteIDBTransaction&, const IDBCursorInfo&);
53     static std::unique_ptr<SQLiteIDBCursor> maybeCreateBackingStoreCursor(SQLiteIDBTransaction&, const uint64_t objectStoreIdentifier, const uint64_t indexIdentifier, const IDBKeyRangeData&);
54
55     SQLiteIDBCursor(SQLiteIDBTransaction&, const IDBCursorInfo&);
56     SQLiteIDBCursor(SQLiteIDBTransaction&, uint64_t objectStoreID, uint64_t indexID, const IDBKeyRangeData&);
57
58     ~SQLiteIDBCursor();
59
60     const IDBResourceIdentifier& identifier() const { return m_cursorIdentifier; }
61     SQLiteIDBTransaction* transaction() const { return m_transaction; }
62
63     int64_t objectStoreID() const { return m_objectStoreID; }
64     int64_t currentRecordRowID() const;
65
66     const IDBKeyData& currentKey() const;
67     const IDBKeyData& currentPrimaryKey() const;
68     IDBValue* currentValue() const;
69
70     bool advance(uint64_t count);
71     bool iterate(const IDBKeyData& targetKey, const IDBKeyData& targetPrimaryKey);
72     bool prefetch();
73
74     bool didComplete() const;
75     bool didError() const;
76
77     void objectStoreRecordsChanged();
78
79     void currentData(IDBGetResult&);
80
81 private:
82     bool establishStatement();
83     bool createSQLiteStatement(const String& sql);
84     bool bindArguments();
85
86     void resetAndRebindStatement();
87
88     enum class FetchResult {
89         Success,
90         Failure,
91         ShouldFetchAgain
92     };
93
94     bool fetch();
95
96     struct SQLiteCursorRecord {
97         IDBCursorRecord record;
98         bool completed { false };
99         bool errored { false };
100         int64_t rowID { 0 };
101         bool isTerminalRecord() const { return completed || errored; }
102     };
103     bool fetchNextRecord(SQLiteCursorRecord&);
104     FetchResult internalFetchNextRecord(SQLiteCursorRecord&);
105
106     void markAsErrored(SQLiteCursorRecord&);
107
108     SQLiteIDBTransaction* m_transaction;
109     IDBResourceIdentifier m_cursorIdentifier;
110     int64_t m_objectStoreID;
111     int64_t m_indexID { IDBIndexInfo::InvalidId };
112     IndexedDB::CursorDirection m_cursorDirection { IndexedDB::CursorDirection::Next };
113     IndexedDB::CursorType m_cursorType;
114     IDBKeyRangeData m_keyRange;
115
116     IDBKeyData m_currentLowerKey;
117     IDBKeyData m_currentUpperKey;
118
119     Deque<SQLiteCursorRecord> m_fetchedRecords;
120     IDBKeyData m_currentKeyForUniqueness;
121
122     std::unique_ptr<SQLiteStatement> m_statement;
123     bool m_statementNeedsReset { true };
124     int64_t m_boundID { 0 };
125
126     bool m_backingStoreCursor { false };
127 };
128
129 } // namespace IDBServer
130 } // namespace WebCore
131
132 #endif // ENABLE(INDEXED_DATABASE)