forked from FerretDB/FerretDB
/
collection.go
537 lines (439 loc) · 14 KB
/
collection.go
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
// Copyright 2021 FerretDB Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sqlite
import (
"context"
"errors"
"fmt"
"sort"
"strings"
sqlite3 "modernc.org/sqlite"
sqlite3lib "modernc.org/sqlite/lib"
"github.com/FerretDB/FerretDB/internal/backends"
"github.com/FerretDB/FerretDB/internal/backends/sqlite/metadata"
"github.com/FerretDB/FerretDB/internal/handler/sjson"
"github.com/FerretDB/FerretDB/internal/types"
"github.com/FerretDB/FerretDB/internal/util/fsql"
"github.com/FerretDB/FerretDB/internal/util/lazyerrors"
"github.com/FerretDB/FerretDB/internal/util/must"
)
// collection implements backends.Collection interface.
type collection struct {
r *metadata.Registry
dbName string
name string
}
// newCollection creates a new Collection.
func newCollection(r *metadata.Registry, dbName, name string) backends.Collection {
return backends.CollectionContract(&collection{
r: r,
dbName: dbName,
name: name,
})
}
// Query implements backends.Collection interface.
func (c *collection) Query(ctx context.Context, params *backends.QueryParams) (*backends.QueryResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return &backends.QueryResult{
Iter: newQueryIterator(ctx, nil, params.OnlyRecordIDs),
}, nil
}
meta := c.r.CollectionGet(ctx, c.dbName, c.name)
if meta == nil {
return &backends.QueryResult{
Iter: newQueryIterator(ctx, nil, params.OnlyRecordIDs),
}, nil
}
q := prepareSelectClause(meta.TableName, params.Comment, meta.Capped(), params.OnlyRecordIDs)
var whereClause string
var args []any
// that logic should exist in one place
// TODO https://github.com/FerretDB/FerretDB/issues/3235
if params.Filter.Len() == 1 {
v, _ := params.Filter.Get("_id")
switch v.(type) {
case string, types.ObjectID:
whereClause = fmt.Sprintf(` WHERE %s = ?`, metadata.IDColumn)
args = []any{string(must.NotFail(sjson.MarshalSingleValue(v)))}
}
}
q += whereClause
q += prepareOrderByClause(params.Sort)
if params.Limit != 0 {
q += ` LIMIT ?`
args = append(args, params.Limit)
}
rows, err := db.QueryContext(ctx, q, args...)
if err != nil {
return nil, lazyerrors.Error(err)
}
return &backends.QueryResult{
Iter: newQueryIterator(ctx, rows, params.OnlyRecordIDs),
}, nil
}
// InsertAll implements backends.Collection interface.
func (c *collection) InsertAll(ctx context.Context, params *backends.InsertAllParams) (*backends.InsertAllResult, error) {
if _, err := c.r.CollectionCreate(ctx, &metadata.CollectionCreateParams{DBName: c.dbName, Name: c.name}); err != nil {
return nil, lazyerrors.Error(err)
}
db := c.r.DatabaseGetExisting(ctx, c.dbName)
meta := c.r.CollectionGet(ctx, c.dbName, c.name)
err := db.InTransaction(ctx, func(tx *fsql.Tx) error {
batchSize := c.r.BatchSize
if batchSize < 1 {
panic("batch-size should be greater or equal to 1")
}
var batch []*types.Document
docs := params.Docs
for len(docs) > 0 {
i := min(batchSize, len(docs))
batch, docs = docs[:i], docs[i:]
q, args, err := prepareInsertStatement(meta.TableName, meta.Capped(), batch)
if err != nil {
return lazyerrors.Error(err)
}
if _, err = tx.ExecContext(ctx, q, args...); err != nil {
var se *sqlite3.Error
if errors.As(err, &se) && se.Code() == sqlite3lib.SQLITE_CONSTRAINT_UNIQUE {
return backends.NewError(backends.ErrorCodeInsertDuplicateID, err)
}
return lazyerrors.Error(err)
}
}
return nil
})
if err != nil {
return nil, err
}
return new(backends.InsertAllResult), nil
}
// UpdateAll implements backends.Collection interface.
func (c *collection) UpdateAll(ctx context.Context, params *backends.UpdateAllParams) (*backends.UpdateAllResult, error) {
var res backends.UpdateAllResult
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return &res, nil
}
meta := c.r.CollectionGet(ctx, c.dbName, c.name)
if meta == nil {
return &res, nil
}
q := fmt.Sprintf(`UPDATE %q SET %s = ? WHERE %s = ?`, meta.TableName, metadata.DefaultColumn, metadata.IDColumn)
err := db.InTransaction(ctx, func(tx *fsql.Tx) error {
for _, doc := range params.Docs {
b, err := sjson.Marshal(doc)
if err != nil {
return lazyerrors.Error(err)
}
id, _ := doc.Get("_id")
must.NotBeZero(id)
arg := string(must.NotFail(sjson.MarshalSingleValue(id)))
r, err := tx.ExecContext(ctx, q, string(b), arg)
if err != nil {
return lazyerrors.Error(err)
}
ra, err := r.RowsAffected()
if err != nil {
return lazyerrors.Error(err)
}
res.Updated += int32(ra)
}
return nil
})
if err != nil {
return nil, lazyerrors.Error(err)
}
return &res, nil
}
// DeleteAll implements backends.Collection interface.
func (c *collection) DeleteAll(ctx context.Context, params *backends.DeleteAllParams) (*backends.DeleteAllResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return &backends.DeleteAllResult{Deleted: 0}, nil
}
meta := c.r.CollectionGet(ctx, c.dbName, c.name)
if meta == nil {
return &backends.DeleteAllResult{Deleted: 0}, nil
}
// TODO https://github.com/FerretDB/FerretDB/issues/3888
var column string
var placeholders []string
var args []any
if params.RecordIDs == nil {
placeholders = make([]string, len(params.IDs))
args = make([]any, len(params.IDs))
for i, id := range params.IDs {
placeholders[i] = "?"
args[i] = string(must.NotFail(sjson.MarshalSingleValue(id)))
}
column = metadata.IDColumn
} else {
placeholders = make([]string, len(params.RecordIDs))
args = make([]any, len(params.RecordIDs))
for i, id := range params.RecordIDs {
placeholders[i] = "?"
args[i] = id
}
column = metadata.RecordIDColumn
}
q := fmt.Sprintf(`DELETE FROM %q WHERE %s IN (%s)`, meta.TableName, column, strings.Join(placeholders, ", "))
res, err := db.ExecContext(ctx, q, args...)
if err != nil {
return nil, lazyerrors.Error(err)
}
ra, err := res.RowsAffected()
if err != nil {
return nil, lazyerrors.Error(err)
}
return &backends.DeleteAllResult{
Deleted: int32(ra),
}, nil
}
// Explain implements backends.Collection interface.
func (c *collection) Explain(ctx context.Context, params *backends.ExplainParams) (*backends.ExplainResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return &backends.ExplainResult{
QueryPlanner: must.NotFail(types.NewDocument()),
}, nil
}
meta := c.r.CollectionGet(ctx, c.dbName, c.name)
if meta == nil {
return &backends.ExplainResult{
QueryPlanner: must.NotFail(types.NewDocument()),
}, nil
}
selectClause := prepareSelectClause(meta.TableName, "", meta.Capped(), false)
var filterPushdown bool
var whereClause string
var args []any
// that logic should exist in one place
// TODO https://github.com/FerretDB/FerretDB/issues/3235
if params.Filter.Len() == 1 {
v, _ := params.Filter.Get("_id")
switch v.(type) {
case string, types.ObjectID:
filterPushdown = true
whereClause = fmt.Sprintf(` WHERE %s = ?`, metadata.IDColumn)
args = []any{string(must.NotFail(sjson.MarshalSingleValue(v)))}
}
}
orderByClause := prepareOrderByClause(params.Sort)
sortPushdown := orderByClause != ""
q := `EXPLAIN QUERY PLAN ` + selectClause + whereClause + orderByClause
var limitPushdown bool
if params.Limit != 0 {
q += ` LIMIT ?`
args = append(args, params.Limit)
limitPushdown = true
}
rows, err := db.QueryContext(ctx, q, args...)
if err != nil {
return nil, lazyerrors.Error(err)
}
defer rows.Close()
queryPlan, err := types.NewArray()
if err != nil {
return nil, lazyerrors.Error(err)
}
for rows.Next() {
var id int32
var parent int32
var notused int32
var detail string
// SQLite query plan can be interpreted as a tree.
// Each row of query plan represents a node of this tree,
// it contains node id, parent id, auxiliary integer field, and a description.
// See https://www.sqlite.org/eqp.html for further details.
if err := rows.Scan(&id, &parent, ¬used, &detail); err != nil {
return nil, lazyerrors.Error(err)
}
queryPlan.Append(fmt.Sprintf("id=%d parent=%d notused=%d detail=%s", id, parent, notused, detail))
}
return &backends.ExplainResult{
QueryPlanner: must.NotFail(types.NewDocument("Plan", queryPlan)),
FilterPushdown: filterPushdown,
SortPushdown: sortPushdown,
LimitPushdown: limitPushdown,
}, nil
}
// Stats implements backends.Collection interface.
func (c *collection) Stats(ctx context.Context, params *backends.CollectionStatsParams) (*backends.CollectionStatsResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return nil, backends.NewError(
backends.ErrorCodeCollectionDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
coll := c.r.CollectionGet(ctx, c.dbName, c.name)
if coll == nil {
return nil, backends.NewError(
backends.ErrorCodeCollectionDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
stats, err := collectionsStats(ctx, db, []*metadata.Collection{coll}, params.Refresh)
if err != nil {
return nil, lazyerrors.Error(err)
}
placeholders := make([]string, 0, len(coll.Settings.Indexes))
args := make([]any, 0, len(coll.Settings.Indexes))
indexMap := map[string]string{}
for _, index := range coll.Settings.Indexes {
placeholders = append(placeholders, "?")
args = append(args, coll.TableName+"_"+index.Name)
indexMap[coll.TableName+"_"+index.Name] = index.Name
}
q := fmt.Sprintf(`
SELECT
name,
pgsize
FROM dbstat
WHERE name IN (%s) AND aggregate = TRUE`,
strings.Join(placeholders, ", "),
)
rows, err := db.QueryContext(ctx, q, args...)
if err != nil {
return nil, lazyerrors.Error(err)
}
defer rows.Close()
indexSizes := make([]backends.IndexSize, len(indexMap))
var i int
for rows.Next() {
var name string
var size int64
if err = rows.Scan(&name, &size); err != nil {
return nil, lazyerrors.Error(err)
}
indexName, ok := indexMap[name]
if !ok {
// new index have been created since fetching metadata
continue
}
indexSizes[i] = backends.IndexSize{
Name: indexName,
Size: size,
}
i++
}
if rows.Err() != nil {
return nil, lazyerrors.Error(rows.Err())
}
return &backends.CollectionStatsResult{
CountDocuments: stats.countDocuments,
SizeTotal: stats.sizeTables + stats.sizeIndexes,
SizeIndexes: stats.sizeIndexes,
SizeCollection: stats.sizeTables,
IndexSizes: indexSizes,
SizeFreeStorage: stats.sizeFreeStorage,
}, nil
}
// Compact implements backends.Collection interface.
func (c *collection) Compact(ctx context.Context, params *backends.CompactParams) (*backends.CompactResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return nil, backends.NewError(
backends.ErrorCodeDatabaseDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
coll := c.r.CollectionGet(ctx, c.dbName, c.name)
if coll == nil {
return nil, backends.NewError(
backends.ErrorCodeCollectionDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
q := `PRAGMA incremental_vacuum`
if params != nil && params.Full {
q = `VACUUM`
}
if _, err := db.ExecContext(ctx, q); err != nil {
return nil, lazyerrors.Error(err)
}
return new(backends.CompactResult), nil
}
// ListIndexes implements backends.Collection interface.
func (c *collection) ListIndexes(ctx context.Context, params *backends.ListIndexesParams) (*backends.ListIndexesResult, error) {
db := c.r.DatabaseGetExisting(ctx, c.dbName)
if db == nil {
return nil, backends.NewError(
backends.ErrorCodeCollectionDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
coll := c.r.CollectionGet(ctx, c.dbName, c.name)
if coll == nil {
return nil, backends.NewError(
backends.ErrorCodeCollectionDoesNotExist,
lazyerrors.Errorf("no ns %s.%s", c.dbName, c.name),
)
}
res := backends.ListIndexesResult{
Indexes: make([]backends.IndexInfo, len(coll.Settings.Indexes)),
}
for i, index := range coll.Settings.Indexes {
res.Indexes[i] = backends.IndexInfo{
Name: index.Name,
Unique: index.Unique,
Key: make([]backends.IndexKeyPair, len(index.Key)),
}
for j, key := range index.Key {
res.Indexes[i].Key[j] = backends.IndexKeyPair{
Field: key.Field,
Descending: key.Descending,
}
}
}
sort.Slice(res.Indexes, func(i, j int) bool {
return res.Indexes[i].Name < res.Indexes[j].Name
})
return &res, nil
}
// CreateIndexes implements backends.Collection interface.
func (c *collection) CreateIndexes(ctx context.Context, params *backends.CreateIndexesParams) (*backends.CreateIndexesResult, error) { //nolint:lll // for readability
indexes := make([]metadata.IndexInfo, len(params.Indexes))
for i, index := range params.Indexes {
indexes[i] = metadata.IndexInfo{
Name: index.Name,
Key: make([]metadata.IndexKeyPair, len(index.Key)),
Unique: index.Unique,
}
for j, key := range index.Key {
indexes[i].Key[j] = metadata.IndexKeyPair{
Field: key.Field,
Descending: key.Descending,
}
}
}
err := c.r.IndexesCreate(ctx, c.dbName, c.name, indexes)
if err != nil {
return nil, lazyerrors.Error(err)
}
return new(backends.CreateIndexesResult), nil
}
// DropIndexes implements backends.Collection interface.
func (c *collection) DropIndexes(ctx context.Context, params *backends.DropIndexesParams) (*backends.DropIndexesResult, error) {
err := c.r.IndexesDrop(ctx, c.dbName, c.name, params.Indexes)
if err != nil {
return nil, lazyerrors.Error(err)
}
return new(backends.DropIndexesResult), nil
}
// check interfaces
var (
_ backends.Collection = (*collection)(nil)
)