Repository navigation
Expand file tree
/
Copy pathindex_view.go
More file actions
584 lines (495 loc) · 17.5 KB
/
Copy pathindex_view.go
File metadata and controls
584 lines (495 loc) · 17.5 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
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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
// Copyright (C) MongoDB, Inc. 2017-present.
//
// 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
package mongo
import (
"bytes"
"context"
"errors"
"fmt"
"strconv"
"go.mongodb.org/mongo-driver/v2/internal/mongoutil"
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
"go.mongodb.org/mongo-driver/v2/internal/serverselector"
"go.mongodb.org/mongo-driver/v2/mongo/options"
"go.mongodb.org/mongo-driver/v2/mongo/readpref"
"go.mongodb.org/mongo-driver/v2/x/bsonx/bsoncore"
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/description"
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/session"
)
// ErrInvalidIndexValue is returned if an index is created with a keys document that has a value that is not a number
// or string.
var ErrInvalidIndexValue = errors.New("invalid index value")
// ErrNonStringIndexName is returned if an index is created with a name that is not a string.
//
// Deprecated: it will be removed in the next major release
var ErrNonStringIndexName = errors.New("index name must be a string")
// IndexView is a type that can be used to create, drop, and list indexes on a collection. An IndexView for a collection
// can be created by a call to Collection.Indexes().
type IndexView struct {
coll *Collection
}
// IndexModel represents a new index to be created.
type IndexModel struct {
// A document describing which keys should be used for the index. It cannot be nil. This must be an order-preserving
// type such as bson.D. Map types such as bson.M are not valid. See https://www.mongodb.com/docs/manual/indexes/#indexes
// for examples of valid documents.
Keys any
// The options to use to create the index.
Options *options.IndexOptionsBuilder
}
// List executes a listIndexes command and returns a cursor over the indexes in the collection.
//
// The opts parameter can be used to specify options for this operation (see the options.ListIndexesOptions
// documentation).
//
// For more information about the command, see https://www.mongodb.com/docs/manual/reference/command/listIndexes/.
func (iv IndexView) List(ctx context.Context, opts ...options.Lister[options.ListIndexesOptions]) (*Cursor, error) {
if ctx == nil {
ctx = context.Background()
}
sess := sessionFromContext(ctx)
if sess == nil && iv.coll.client.sessionPool != nil {
sess = session.NewImplicitClientSession(iv.coll.client.sessionPool, iv.coll.client.id)
}
err := iv.coll.client.validSession(sess)
if err != nil {
closeImplicitSession(sess)
return nil, err
}
var selector description.ServerSelector
retry := driver.RetryNone
if iv.coll.client.retryReads {
retry = driver.RetryOncePerCommand
}
cursorOpts := iv.coll.client.createBaseCursorOptions(iv.coll.client.retryReads)
selector = &serverselector.Composite{
Selectors: []description.ServerSelector{
&serverselector.ReadPref{ReadPref: readpref.Primary()},
&serverselector.Latency{Latency: iv.coll.client.localThreshold},
},
}
selector = makeReadPrefSelector(sess, selector, iv.coll.client.localThreshold)
op := listIndexesOp{
session: sess,
monitor: iv.coll.client.monitor,
selector: selector,
clock: iv.coll.client.clock,
retry: &retry,
maxAdaptiveRetries: cursorOpts.MaxAdaptiveRetries,
enableOverloadRetargeting: cursorOpts.EnableOverloadRetargeting,
database: iv.coll.db.name,
collection: iv.coll.name,
deployment: iv.coll.client.deployment,
serverAPI: iv.coll.client.serverAPI,
timeout: iv.coll.client.timeout,
crypt: iv.coll.client.cryptFLE,
authenticator: iv.coll.client.authenticator,
}
cursorOpts.MarshalValueEncoderFn = newEncoderFn(iv.coll.bsonOpts, iv.coll.registry)
args, err := mongoutil.NewOptions[options.ListIndexesOptions](opts...)
if err != nil {
return nil, fmt.Errorf("failed to construct options from builder: %w", err)
}
if args.BatchSize != nil {
op.batchSize = args.BatchSize
cursorOpts.BatchSize = *args.BatchSize
}
if rawData, ok := optionsutil.Value(args.Internal, "rawData").(bool); ok {
op.rawData = &rawData
}
err = op.execute(ctx)
if err != nil {
// for namespaceNotFound errors, return an empty cursor and do not throw an error
closeImplicitSession(sess)
var de driver.Error
if errors.As(err, &de) && de.NamespaceNotFound() {
return newEmptyCursor(), nil
}
return nil, wrapErrors(err)
}
bc, err := op.result(cursorOpts)
if err != nil {
closeImplicitSession(sess)
return nil, wrapErrors(err)
}
cursor, err := newCursorWithSession(bc, iv.coll.bsonOpts, iv.coll.registry, sess,
// This value is included for completeness, but a server will never return
// a tailable awaitData cursor from a listIndexes operation.
withCursorOptionClientTimeout(iv.coll.client.timeout))
return cursor, wrapErrors(err)
}
// ListSpecifications executes a List command and returns a slice of returned IndexSpecifications
func (iv IndexView) ListSpecifications(
ctx context.Context,
opts ...options.Lister[options.ListIndexesOptions],
) ([]IndexSpecification, error) {
cursor, err := iv.List(ctx, opts...)
if err != nil {
return nil, err
}
var resp []indexListSpecificationResponse
if err := cursor.All(ctx, &resp); err != nil {
return nil, err
}
namespace := iv.coll.db.Name() + "." + iv.coll.Name()
specs := make([]IndexSpecification, len(resp))
for idx, spec := range resp {
specs[idx] = IndexSpecification(spec)
specs[idx].Namespace = namespace
}
return specs, nil
}
// CreateOne executes a createIndexes command to create an index on the collection and returns the name of the new
// index. See the IndexView.CreateMany documentation for more information and an example.
func (iv IndexView) CreateOne(
ctx context.Context,
model IndexModel,
opts ...options.Lister[options.CreateIndexesOptions],
) (string, error) {
names, err := iv.CreateMany(ctx, []IndexModel{model}, opts...)
if err != nil {
return "", err
}
return names[0], nil
}
// CreateMany executes a createIndexes command to create multiple indexes on the collection and returns the names of
// the new indexes.
//
// For each IndexModel in the models parameter, the index name can be specified via the Options field. If a name is not
// given, it will be generated from the Keys document.
//
// The opts parameter can be used to specify options for this operation (see the options.CreateIndexesOptions
// documentation).
//
// For more information about the command, see https://www.mongodb.com/docs/manual/reference/command/createIndexes/.
func (iv IndexView) CreateMany(
ctx context.Context,
models []IndexModel,
opts ...options.Lister[options.CreateIndexesOptions],
) ([]string, error) {
names := make([]string, 0, len(models))
var indexes bsoncore.Document
aidx, indexes := bsoncore.AppendArrayStart(indexes)
for i, model := range models {
if model.Keys == nil {
return nil, fmt.Errorf("index model keys cannot be nil")
}
if isUnorderedMap(model.Keys) {
return nil, ErrMapForOrderedArgument{"keys"}
}
keys, err := marshal(model.Keys, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
name, err := getOrGenerateIndexName(keys, model)
if err != nil {
return nil, err
}
names = append(names, name)
var iidx int32
iidx, indexes = bsoncore.AppendDocumentElementStart(indexes, strconv.Itoa(i))
indexes = bsoncore.AppendDocumentElement(indexes, "key", keys)
if model.Options == nil {
model.Options = options.Index()
}
model.Options.SetName(name)
optsDoc, err := iv.createOptionsDoc(model.Options)
if err != nil {
return nil, err
}
indexes = bsoncore.AppendDocument(indexes, optsDoc)
indexes, err = bsoncore.AppendDocumentEnd(indexes, iidx)
if err != nil {
return nil, err
}
}
indexes, err := bsoncore.AppendArrayEnd(indexes, aidx)
if err != nil {
return nil, err
}
sess := sessionFromContext(ctx)
if sess == nil && iv.coll.client.sessionPool != nil {
sess = session.NewImplicitClientSession(iv.coll.client.sessionPool, iv.coll.client.id)
defer sess.EndSession()
}
err = iv.coll.client.validSession(sess)
if err != nil {
return nil, err
}
wc := iv.coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !wc.Acknowledged() {
sess = nil
}
maxAdaptiveRetries := iv.coll.client.effectiveAdaptiveRetries(iv.coll.client.retryWrites)
selector := makePinnedSelector(sess, iv.coll.writeSelector)
args, err := mongoutil.NewOptions[options.CreateIndexesOptions](opts...)
if err != nil {
return nil, fmt.Errorf("failed to construct options from builder: %w", err)
}
op := &createIndexesOp{
indexes: indexes,
session: sess,
writeConcern: wc,
clock: iv.coll.client.clock,
maxAdaptiveRetries: maxAdaptiveRetries,
enableOverloadRetargeting: iv.coll.client.enableOverloadRetargeting,
database: iv.coll.db.name,
collection: iv.coll.name,
monitor: iv.coll.client.monitor,
deployment: iv.coll.client.deployment,
selector: selector,
serverAPI: iv.coll.client.serverAPI,
timeout: iv.coll.client.timeout,
crypt: iv.coll.client.cryptFLE,
authenticator: iv.coll.client.authenticator,
}
if args.CommitQuorum != nil {
commitQuorum, err := marshalValue(args.CommitQuorum, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
op.commitQuorum = commitQuorum
}
if rawData, ok := optionsutil.Value(args.Internal, "rawData").(bool); ok {
op.rawData = &rawData
}
_, err = processWriteError(op.execute(ctx))
if err != nil {
return nil, err
}
return names, nil
}
func (iv IndexView) createOptionsDoc(opts options.Lister[options.IndexOptions]) (bsoncore.Document, error) {
args, err := mongoutil.NewOptions[options.IndexOptions](opts)
if err != nil {
return nil, fmt.Errorf("failed to construct options from builder: %w", err)
}
optsDoc := bsoncore.Document{}
if args.ExpireAfterSeconds != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "expireAfterSeconds", *args.ExpireAfterSeconds)
}
if args.Name != nil {
optsDoc = bsoncore.AppendStringElement(optsDoc, "name", *args.Name)
}
if args.Sparse != nil {
optsDoc = bsoncore.AppendBooleanElement(optsDoc, "sparse", *args.Sparse)
}
if args.StorageEngine != nil {
doc, err := marshal(args.StorageEngine, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
optsDoc = bsoncore.AppendDocumentElement(optsDoc, "storageEngine", doc)
}
if args.Unique != nil {
optsDoc = bsoncore.AppendBooleanElement(optsDoc, "unique", *args.Unique)
}
if args.Version != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "v", *args.Version)
}
if args.DefaultLanguage != nil {
optsDoc = bsoncore.AppendStringElement(optsDoc, "default_language", *args.DefaultLanguage)
}
if args.LanguageOverride != nil {
optsDoc = bsoncore.AppendStringElement(optsDoc, "language_override", *args.LanguageOverride)
}
if args.TextVersion != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "textIndexVersion", *args.TextVersion)
}
if args.Weights != nil {
doc, err := marshal(args.Weights, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
optsDoc = bsoncore.AppendDocumentElement(optsDoc, "weights", doc)
}
if args.SphereVersion != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "2dsphereIndexVersion", *args.SphereVersion)
}
if args.Bits != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "bits", *args.Bits)
}
if args.Max != nil {
optsDoc = bsoncore.AppendDoubleElement(optsDoc, "max", *args.Max)
}
if args.Min != nil {
optsDoc = bsoncore.AppendDoubleElement(optsDoc, "min", *args.Min)
}
if args.BucketSize != nil {
optsDoc = bsoncore.AppendInt32Element(optsDoc, "bucketSize", *args.BucketSize)
}
if args.PartialFilterExpression != nil {
doc, err := marshal(args.PartialFilterExpression, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
optsDoc = bsoncore.AppendDocumentElement(optsDoc, "partialFilterExpression", doc)
}
if args.Collation != nil {
optsDoc = bsoncore.AppendDocumentElement(optsDoc, "collation", bsoncore.Document(toDocument(args.Collation)))
}
if args.WildcardProjection != nil {
doc, err := marshal(args.WildcardProjection, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return nil, err
}
optsDoc = bsoncore.AppendDocumentElement(optsDoc, "wildcardProjection", doc)
}
if args.Hidden != nil {
optsDoc = bsoncore.AppendBooleanElement(optsDoc, "hidden", *args.Hidden)
}
return optsDoc, nil
}
func (iv IndexView) drop(ctx context.Context, index any, opts ...options.Lister[options.DropIndexesOptions]) error {
args, err := mongoutil.NewOptions[options.DropIndexesOptions](opts...)
if err != nil {
return fmt.Errorf("failed to construct options from builder: %w", err)
}
if ctx == nil {
ctx = context.Background()
}
sess := sessionFromContext(ctx)
if sess == nil && iv.coll.client.sessionPool != nil {
sess = session.NewImplicitClientSession(iv.coll.client.sessionPool, iv.coll.client.id)
defer sess.EndSession()
}
err = iv.coll.client.validSession(sess)
if err != nil {
return err
}
wc := iv.coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !wc.Acknowledged() {
sess = nil
}
maxAdaptiveRetries := iv.coll.client.effectiveAdaptiveRetries(iv.coll.client.retryWrites)
selector := makePinnedSelector(sess, iv.coll.writeSelector)
op := dropIndexesOp{
index: index,
session: sess,
writeConcern: wc,
monitor: iv.coll.client.monitor,
maxAdaptiveRetries: maxAdaptiveRetries,
enableOverloadRetargeting: iv.coll.client.enableOverloadRetargeting,
selector: selector,
clock: iv.coll.client.clock,
database: iv.coll.db.name,
collection: iv.coll.name,
deployment: iv.coll.client.deployment,
serverAPI: iv.coll.client.serverAPI,
timeout: iv.coll.client.timeout,
crypt: iv.coll.client.cryptFLE,
authenticator: iv.coll.client.authenticator,
}
if rawData, ok := optionsutil.Value(args.Internal, "rawData").(bool); ok {
op.rawData = &rawData
}
err = op.execute(ctx)
if err != nil {
return wrapErrors(err)
}
return nil
}
// DropOne executes a dropIndexes operation to drop an index on the collection.
//
// The name parameter should be the name of the index to drop. If the name is
// "*", ErrMultipleIndexDrop will be returned without running the command
// because doing so would drop all indexes.
//
// The opts parameter can be used to specify options for this operation (see the
// options.DropIndexesOptions documentation).
//
// For more information about the command, see https://www.mongodb.com/docs/manual/reference/command/dropIndexes/.
func (iv IndexView) DropOne(
ctx context.Context,
name string,
opts ...options.Lister[options.DropIndexesOptions],
) error {
// For more information about the command, see
// https://www.mongodb.com/docs/manual/reference/command/dropIndexes/.
if name == "*" {
return ErrMultipleIndexDrop
}
return iv.drop(ctx, name, opts...)
}
// DropWithKey drops a collection index by key using the dropIndexes operation.
//
// This function is useful to drop an index using its key specification instead of its name.
func (iv IndexView) DropWithKey(ctx context.Context, keySpecDocument any, opts ...options.Lister[options.DropIndexesOptions]) error {
doc, err := marshal(keySpecDocument, iv.coll.bsonOpts, iv.coll.registry)
if err != nil {
return err
}
return iv.drop(ctx, doc, opts...)
}
// DropAll executes a dropIndexes operation to drop all indexes on the collection.
//
// The opts parameter can be used to specify options for this operation (see the
// options.DropIndexesOptions documentation).
//
// For more information about the command, see
// https://www.mongodb.com/docs/manual/reference/command/dropIndexes/.
func (iv IndexView) DropAll(
ctx context.Context,
opts ...options.Lister[options.DropIndexesOptions],
) error {
return iv.drop(ctx, "*", opts...)
}
func getOrGenerateIndexName(keySpecDocument bsoncore.Document, model IndexModel) (string, error) {
args, err := mongoutil.NewOptions[options.IndexOptions](model.Options)
if err != nil {
return "", fmt.Errorf("failed to construct options from builder: %w", err)
}
if args != nil && args.Name != nil {
return *args.Name, nil
}
name := bytes.NewBufferString("")
first := true
elems, err := keySpecDocument.Elements()
if err != nil {
return "", err
}
for _, elem := range elems {
if !first {
_, err := name.WriteRune('_')
if err != nil {
return "", err
}
}
_, err := name.WriteString(elem.Key())
if err != nil {
return "", err
}
_, err = name.WriteRune('_')
if err != nil {
return "", err
}
var value string
bsonValue := elem.Value()
switch bsonValue.Type {
case bsoncore.TypeInt32:
value = fmt.Sprintf("%d", bsonValue.Int32())
case bsoncore.TypeInt64:
value = fmt.Sprintf("%d", bsonValue.Int64())
case bsoncore.TypeString:
value = bsonValue.StringValue()
default:
return "", ErrInvalidIndexValue
}
_, err = name.WriteString(value)
if err != nil {
return "", err
}
first = false
}
return name.String(), nil
}