-
-
Notifications
You must be signed in to change notification settings - Fork 35.3k
Expand file tree
/
Copy pathnode_sqlite.h
More file actions
451 lines (388 loc) Β· 16.3 KB
/
node_sqlite.h
File metadata and controls
451 lines (388 loc) Β· 16.3 KB
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
#ifndef SRC_NODE_SQLITE_H_
#define SRC_NODE_SQLITE_H_
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#include "base_object.h"
#include "lru_cache-inl.h"
#include "node_mem.h"
#include "sqlite3.h"
#include "util.h"
#include <array>
#include <list>
#include <map>
#include <optional>
#include <string_view>
#include <unordered_set>
#include <vector>
namespace node {
namespace sqlite {
// Mapping from JavaScript property names to SQLite limit constants
struct LimitInfo {
std::string_view js_name;
int sqlite_limit_id;
};
inline constexpr std::array<LimitInfo, 11> kLimitMapping = {{
{"length", SQLITE_LIMIT_LENGTH},
{"sqlLength", SQLITE_LIMIT_SQL_LENGTH},
{"column", SQLITE_LIMIT_COLUMN},
{"exprDepth", SQLITE_LIMIT_EXPR_DEPTH},
{"compoundSelect", SQLITE_LIMIT_COMPOUND_SELECT},
{"vdbeOp", SQLITE_LIMIT_VDBE_OP},
{"functionArg", SQLITE_LIMIT_FUNCTION_ARG},
{"attach", SQLITE_LIMIT_ATTACHED},
{"likePatternLength", SQLITE_LIMIT_LIKE_PATTERN_LENGTH},
{"variableNumber", SQLITE_LIMIT_VARIABLE_NUMBER},
{"triggerDepth", SQLITE_LIMIT_TRIGGER_DEPTH},
}};
constexpr bool CheckLimitIndices() {
for (size_t i = 0; i < kLimitMapping.size(); ++i) {
if (kLimitMapping[i].sqlite_limit_id != static_cast<int>(i)) {
return false;
}
}
return true;
}
static_assert(
CheckLimitIndices(),
"Each kLimitMapping entry's sqlite_limit_id must match its index");
class DatabaseOpenConfiguration {
public:
explicit DatabaseOpenConfiguration(std::string&& location)
: location_(std::move(location)) {}
inline const std::string& location() const { return location_; }
inline bool get_read_only() const { return read_only_; }
inline void set_read_only(bool flag) { read_only_ = flag; }
inline bool get_enable_foreign_keys() const { return enable_foreign_keys_; }
inline void set_enable_foreign_keys(bool flag) {
enable_foreign_keys_ = flag;
}
inline bool get_enable_dqs() const { return enable_dqs_; }
inline void set_enable_dqs(bool flag) { enable_dqs_ = flag; }
inline void set_timeout(int timeout) { timeout_ = timeout; }
inline int get_timeout() { return timeout_; }
inline void set_use_big_ints(bool flag) { use_big_ints_ = flag; }
inline bool get_use_big_ints() const { return use_big_ints_; }
inline void set_return_arrays(bool flag) { return_arrays_ = flag; }
inline bool get_return_arrays() const { return return_arrays_; }
inline void set_allow_bare_named_params(bool flag) {
allow_bare_named_params_ = flag;
}
inline bool get_allow_bare_named_params() const {
return allow_bare_named_params_;
}
inline void set_allow_unknown_named_params(bool flag) {
allow_unknown_named_params_ = flag;
}
inline bool get_allow_unknown_named_params() const {
return allow_unknown_named_params_;
}
inline void set_enable_defensive(bool flag) { defensive_ = flag; }
inline bool get_enable_defensive() const { return defensive_; }
inline void set_initial_limit(int sqlite_limit_id, int value) {
initial_limits_.at(sqlite_limit_id) = value;
}
inline const std::array<std::optional<int>, kLimitMapping.size()>&
initial_limits() const {
return initial_limits_;
}
private:
std::string location_;
bool read_only_ = false;
bool enable_foreign_keys_ = true;
bool enable_dqs_ = false;
int timeout_ = 0;
bool use_big_ints_ = false;
bool return_arrays_ = false;
bool allow_bare_named_params_ = true;
bool allow_unknown_named_params_ = false;
bool defensive_ = true;
std::array<std::optional<int>, kLimitMapping.size()> initial_limits_{};
};
class DatabaseSync;
class DatabaseSyncLimits;
class StatementSyncIterator;
class StatementSync;
class BackupJob;
class StatementExecutionHelper {
public:
static v8::MaybeLocal<v8::Value> All(Environment* env,
DatabaseSync* db,
sqlite3_stmt* stmt,
bool return_arrays,
bool use_big_ints);
static v8::MaybeLocal<v8::Object> Run(Environment* env,
DatabaseSync* db,
sqlite3_stmt* stmt,
bool use_big_ints);
static BaseObjectPtr<StatementSyncIterator> Iterate(
Environment* env, BaseObjectPtr<StatementSync> stmt);
static v8::MaybeLocal<v8::Value> ColumnToValue(Environment* env,
sqlite3_stmt* stmt,
const int column,
bool use_big_ints);
static v8::MaybeLocal<v8::Name> ColumnNameToName(Environment* env,
sqlite3_stmt* stmt,
const int column);
static v8::MaybeLocal<v8::Value> Get(Environment* env,
DatabaseSync* db,
sqlite3_stmt* stmt,
bool return_arrays,
bool use_big_ints);
};
class DatabaseSync : public BaseObject {
public:
enum InternalFields {
kAuthorizerCallback = BaseObject::kInternalFieldCount,
kLimitsObject,
kInternalFieldCount
};
DatabaseSync(Environment* env,
v8::Local<v8::Object> object,
DatabaseOpenConfiguration&& open_config,
bool open,
bool allow_load_extension);
void MemoryInfo(MemoryTracker* tracker) const override;
static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Open(const v8::FunctionCallbackInfo<v8::Value>& args);
static void IsOpenGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
static void IsTransactionGetter(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Prepare(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Exec(const v8::FunctionCallbackInfo<v8::Value>& args);
static void CreateTagStore(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Location(const v8::FunctionCallbackInfo<v8::Value>& args);
static void CustomFunction(const v8::FunctionCallbackInfo<v8::Value>& args);
static void AggregateFunction(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void CreateSession(const v8::FunctionCallbackInfo<v8::Value>& args);
static void ApplyChangeset(const v8::FunctionCallbackInfo<v8::Value>& args);
static void EnableLoadExtension(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void EnableDefensive(const v8::FunctionCallbackInfo<v8::Value>& args);
static void LimitsGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
static void LoadExtension(const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetAuthorizer(const v8::FunctionCallbackInfo<v8::Value>& args);
static int AuthorizerCallback(void* user_data,
int action_code,
const char* param1,
const char* param2,
const char* param3,
const char* param4);
void FinalizeStatements();
void RemoveBackup(BackupJob* backup);
void AddBackup(BackupJob* backup);
void FinalizeBackups();
void UntrackStatement(StatementSync* statement);
bool IsOpen();
bool use_big_ints() const { return open_config_.get_use_big_ints(); }
bool return_arrays() const { return open_config_.get_return_arrays(); }
bool allow_bare_named_params() const {
return open_config_.get_allow_bare_named_params();
}
bool allow_unknown_named_params() const {
return open_config_.get_allow_unknown_named_params();
}
sqlite3* Connection();
// In some situations, such as when using custom functions, it is possible
// that SQLite reports an error while JavaScript already has a pending
// exception. In this case, the SQLite error should be ignored. These methods
// enable that use case.
void SetIgnoreNextSQLiteError(bool ignore);
bool ShouldIgnoreSQLiteError();
SET_MEMORY_INFO_NAME(DatabaseSync)
SET_SELF_SIZE(DatabaseSync)
private:
bool Open();
void DeleteSessions();
~DatabaseSync() override;
DatabaseOpenConfiguration open_config_;
bool allow_load_extension_;
bool enable_load_extension_;
sqlite3* connection_;
bool ignore_next_sqlite_error_;
std::set<BackupJob*> backups_;
std::set<sqlite3_session*> sessions_;
std::unordered_set<StatementSync*> statements_;
friend class DatabaseSyncLimits;
friend class Session;
friend class SQLTagStore;
friend class StatementExecutionHelper;
};
class StatementSync : public BaseObject {
public:
StatementSync(Environment* env,
v8::Local<v8::Object> object,
BaseObjectPtr<DatabaseSync> db,
sqlite3_stmt* stmt);
void MemoryInfo(MemoryTracker* tracker) const override;
static v8::Local<v8::FunctionTemplate> GetConstructorTemplate(
Environment* env);
static BaseObjectPtr<StatementSync> Create(Environment* env,
BaseObjectPtr<DatabaseSync> db,
sqlite3_stmt* stmt);
static void All(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Iterate(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Get(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Run(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Columns(const v8::FunctionCallbackInfo<v8::Value>& args);
static void SourceSQLGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
static void ExpandedSQLGetter(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetAllowBareNamedParameters(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetAllowUnknownNamedParameters(
const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetReadBigInts(const v8::FunctionCallbackInfo<v8::Value>& args);
static void SetReturnArrays(const v8::FunctionCallbackInfo<v8::Value>& args);
v8::MaybeLocal<v8::Value> ColumnToValue(const int column);
v8::MaybeLocal<v8::Name> ColumnNameToName(const int column);
bool GetCachedColumnNames(v8::LocalVector<v8::Name>* keys);
void Finalize();
bool IsFinalized();
SET_MEMORY_INFO_NAME(StatementSync)
SET_SELF_SIZE(StatementSync)
private:
~StatementSync() override;
BaseObjectPtr<DatabaseSync> db_;
sqlite3_stmt* statement_;
bool return_arrays_ = false;
bool use_big_ints_;
bool allow_bare_named_params_;
bool allow_unknown_named_params_;
uint64_t reset_generation_ = 0;
std::optional<std::map<std::string, std::string>> bare_named_params_;
inline int ResetStatement();
std::vector<v8::Global<v8::Name>> cached_column_names_;
int cached_column_names_reprepare_count_ = -1;
void InvalidateColumnNameCache();
bool BindParams(const v8::FunctionCallbackInfo<v8::Value>& args);
bool BindValue(const v8::Local<v8::Value>& value, const int index);
friend class DatabaseSync;
friend class StatementSyncIterator;
friend class SQLTagStore;
friend class StatementExecutionHelper;
};
class StatementSyncIterator : public BaseObject {
public:
StatementSyncIterator(Environment* env,
v8::Local<v8::Object> object,
BaseObjectPtr<StatementSync> stmt);
void MemoryInfo(MemoryTracker* tracker) const override;
static v8::Local<v8::FunctionTemplate> GetConstructorTemplate(
Environment* env);
static BaseObjectPtr<StatementSyncIterator> Create(
Environment* env, BaseObjectPtr<StatementSync> stmt);
static void Next(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Return(const v8::FunctionCallbackInfo<v8::Value>& args);
SET_MEMORY_INFO_NAME(StatementSyncIterator)
SET_SELF_SIZE(StatementSyncIterator)
private:
~StatementSyncIterator() override;
BaseObjectPtr<StatementSync> stmt_;
bool done_;
uint64_t statement_reset_generation_;
};
using Sqlite3ChangesetGenFunc = int (*)(sqlite3_session*, int*, void**);
class Session : public BaseObject {
public:
Session(Environment* env,
v8::Local<v8::Object> object,
BaseObjectWeakPtr<DatabaseSync> database,
sqlite3_session* session);
~Session() override;
template <Sqlite3ChangesetGenFunc sqliteChangesetFunc>
static void Changeset(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Close(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Dispose(const v8::FunctionCallbackInfo<v8::Value>& args);
static v8::Local<v8::FunctionTemplate> GetConstructorTemplate(
Environment* env);
static BaseObjectPtr<Session> Create(Environment* env,
BaseObjectWeakPtr<DatabaseSync> database,
sqlite3_session* session);
void MemoryInfo(MemoryTracker* tracker) const override;
SET_MEMORY_INFO_NAME(Session)
SET_SELF_SIZE(Session)
private:
void Delete();
sqlite3_session* session_;
BaseObjectWeakPtr<DatabaseSync> database_; // The Parent Database
};
class SQLTagStore : public BaseObject {
public:
enum InternalFields {
kDatabaseObject = BaseObject::kInternalFieldCount,
kInternalFieldCount
};
SQLTagStore(Environment* env,
v8::Local<v8::Object> object,
BaseObjectWeakPtr<DatabaseSync> database,
int capacity);
~SQLTagStore() override;
static BaseObjectPtr<SQLTagStore> Create(
Environment* env, BaseObjectWeakPtr<DatabaseSync> database, int capacity);
static v8::Local<v8::FunctionTemplate> GetConstructorTemplate(
Environment* env);
static void All(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Get(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Iterate(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Run(const v8::FunctionCallbackInfo<v8::Value>& args);
static void Clear(const v8::FunctionCallbackInfo<v8::Value>& args);
static void CapacityGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
static void DatabaseGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
static void SizeGetter(const v8::FunctionCallbackInfo<v8::Value>& args);
void MemoryInfo(MemoryTracker* tracker) const override;
SET_MEMORY_INFO_NAME(SQLTagStore)
SET_SELF_SIZE(SQLTagStore)
private:
static BaseObjectPtr<StatementSync> PrepareStatement(
const v8::FunctionCallbackInfo<v8::Value>& args);
BaseObjectWeakPtr<DatabaseSync> database_;
LRUCache<std::string, BaseObjectPtr<StatementSync>> sql_tags_;
friend class StatementExecutionHelper;
};
class UserDefinedFunction {
public:
UserDefinedFunction(Environment* env,
v8::Local<v8::Function> fn,
DatabaseSync* db,
bool use_bigint_args);
~UserDefinedFunction();
static void xFunc(sqlite3_context* ctx, int argc, sqlite3_value** argv);
static void xDestroy(void* self);
private:
Environment* env_;
v8::Global<v8::Function> fn_;
DatabaseSync* db_;
bool use_bigint_args_;
};
class DatabaseSyncLimits : public BaseObject {
public:
DatabaseSyncLimits(Environment* env,
v8::Local<v8::Object> object,
BaseObjectWeakPtr<DatabaseSync> database);
~DatabaseSyncLimits() override;
void MemoryInfo(MemoryTracker* tracker) const override;
static v8::Local<v8::ObjectTemplate> GetTemplate(Environment* env);
static BaseObjectPtr<DatabaseSyncLimits> Create(
Environment* env, BaseObjectWeakPtr<DatabaseSync> database);
static v8::Intercepted LimitsGetter(
v8::Local<v8::Name> property,
const v8::PropertyCallbackInfo<v8::Value>& info);
static v8::Intercepted LimitsSetter(
v8::Local<v8::Name> property,
v8::Local<v8::Value> value,
const v8::PropertyCallbackInfo<void>& info);
static v8::Intercepted LimitsQuery(
v8::Local<v8::Name> property,
const v8::PropertyCallbackInfo<v8::Integer>& info);
static void LimitsEnumerator(const v8::PropertyCallbackInfo<v8::Array>& info);
SET_MEMORY_INFO_NAME(DatabaseSyncLimits)
SET_SELF_SIZE(DatabaseSyncLimits)
private:
BaseObjectWeakPtr<DatabaseSync> database_;
};
} // namespace sqlite
} // namespace node
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
#endif // SRC_NODE_SQLITE_H_