forked from DemoLiang/mongo-driver
/
collection.go
executable file
·1429 lines (1229 loc) · 38.8 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
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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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 (
"context"
"errors"
"fmt"
"strings"
"time"
"go.mongodb.org/mongo-driver/bson"
"go.mongodb.org/mongo-driver/bson/bsoncodec"
"go.mongodb.org/mongo-driver/bson/bsontype"
"go.mongodb.org/mongo-driver/mongo/options"
"go.mongodb.org/mongo-driver/mongo/readconcern"
"go.mongodb.org/mongo-driver/mongo/readpref"
"go.mongodb.org/mongo-driver/mongo/writeconcern"
"go.mongodb.org/mongo-driver/x/bsonx/bsoncore"
"go.mongodb.org/mongo-driver/x/mongo/driver"
"go.mongodb.org/mongo-driver/x/mongo/driver/description"
"go.mongodb.org/mongo-driver/x/mongo/driver/operation"
"go.mongodb.org/mongo-driver/x/mongo/driver/session"
)
// Collection performs operations on a given collection.
type Collection struct {
client *Client
db *Database
name string
readConcern *readconcern.ReadConcern
writeConcern *writeconcern.WriteConcern
readPreference *readpref.ReadPref
readSelector description.ServerSelector
writeSelector description.ServerSelector
registry *bsoncodec.Registry
}
// aggregateParams is used to store information to configure an Aggregate operation.
type aggregateParams struct {
ctx context.Context
pipeline interface{}
client *Client
registry *bsoncodec.Registry
readConcern *readconcern.ReadConcern
writeConcern *writeconcern.WriteConcern
retryRead bool
db string
col string
readSelector description.ServerSelector
writeSelector description.ServerSelector
readPreference *readpref.ReadPref
opts []*options.AggregateOptions
}
func closeImplicitSession(sess *session.Client) {
if sess != nil && sess.SessionType == session.Implicit {
sess.EndSession()
}
}
func newCollection(db *Database, name string, opts ...*options.CollectionOptions) *Collection {
collOpt := options.MergeCollectionOptions(opts...)
rc := db.readConcern
if collOpt.ReadConcern != nil {
rc = collOpt.ReadConcern
}
wc := db.writeConcern
if collOpt.WriteConcern != nil {
wc = collOpt.WriteConcern
}
rp := db.readPreference
if collOpt.ReadPreference != nil {
rp = collOpt.ReadPreference
}
reg := db.registry
if collOpt.Registry != nil {
reg = collOpt.Registry
}
readSelector := description.CompositeSelector([]description.ServerSelector{
description.ReadPrefSelector(rp),
description.LatencySelector(db.client.localThreshold),
})
writeSelector := description.CompositeSelector([]description.ServerSelector{
description.WriteSelector(),
description.LatencySelector(db.client.localThreshold),
})
coll := &Collection{
client: db.client,
db: db,
name: name,
readPreference: rp,
readConcern: rc,
writeConcern: wc,
readSelector: readSelector,
writeSelector: writeSelector,
registry: reg,
}
return coll
}
func (coll *Collection) copy() *Collection {
return &Collection{
client: coll.client,
db: coll.db,
name: coll.name,
readConcern: coll.readConcern,
writeConcern: coll.writeConcern,
readPreference: coll.readPreference,
readSelector: coll.readSelector,
writeSelector: coll.writeSelector,
registry: coll.registry,
}
}
// Clone creates a copy of this collection with updated options, if any are given.
func (coll *Collection) Clone(opts ...*options.CollectionOptions) (*Collection, error) {
copyColl := coll.copy()
optsColl := options.MergeCollectionOptions(opts...)
if optsColl.ReadConcern != nil {
copyColl.readConcern = optsColl.ReadConcern
}
if optsColl.WriteConcern != nil {
copyColl.writeConcern = optsColl.WriteConcern
}
if optsColl.ReadPreference != nil {
copyColl.readPreference = optsColl.ReadPreference
}
if optsColl.Registry != nil {
copyColl.registry = optsColl.Registry
}
copyColl.readSelector = description.CompositeSelector([]description.ServerSelector{
description.ReadPrefSelector(copyColl.readPreference),
description.LatencySelector(copyColl.client.localThreshold),
})
return copyColl, nil
}
// Name provides access to the name of the collection.
func (coll *Collection) Name() string {
return coll.name
}
// Database provides access to the database that contains the collection.
func (coll *Collection) Database() *Database {
return coll.db
}
// BulkWrite performs a bulk write operation.
//
// See https://docs.mongodb.com/manual/core/bulk-write-operations/.
func (coll *Collection) BulkWrite(ctx context.Context, models []WriteModel,
opts ...*options.BulkWriteOptions) (*BulkWriteResult, error) {
if len(models) == 0 {
return nil, ErrEmptySlice
}
if ctx == nil {
ctx = context.Background()
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
sess, err := session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
defer sess.EndSession()
}
err := coll.client.validSession(sess)
if err != nil {
return nil, err
}
wc := coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !writeconcern.AckWrite(wc) {
sess = nil
}
selector := makePinnedSelector(sess, coll.writeSelector)
for _, model := range models {
if model == nil {
return nil, ErrNilDocument
}
}
bwo := options.MergeBulkWriteOptions(opts...)
op := bulkWrite{
ordered: bwo.Ordered,
bypassDocumentValidation: bwo.BypassDocumentValidation,
models: models,
session: sess,
collection: coll,
selector: selector,
writeConcern: wc,
}
err = op.execute(ctx)
return &op.result, replaceErrors(err)
}
func (coll *Collection) insert(ctx context.Context, documents []interface{},
opts ...*options.InsertManyOptions) ([]interface{}, error) {
if ctx == nil {
ctx = context.Background()
}
result := make([]interface{}, len(documents))
docs := make([]bsoncore.Document, len(documents))
for i, doc := range documents {
var err error
docs[i], result[i], err = transformAndEnsureIDv2(coll.registry, doc)
if err != nil {
return nil, err
}
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
var err error
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
defer sess.EndSession()
}
err := coll.client.validSession(sess)
if err != nil {
return nil, err
}
wc := coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !writeconcern.AckWrite(wc) {
sess = nil
}
selector := makePinnedSelector(sess, coll.writeSelector)
op := operation.NewInsert(docs...).
Session(sess).WriteConcern(wc).CommandMonitor(coll.client.monitor).
ServerSelector(selector).ClusterClock(coll.client.clock).
Database(coll.db.name).Collection(coll.name).
Deployment(coll.client.topology)
imo := options.MergeInsertManyOptions(opts...)
if imo.BypassDocumentValidation != nil && *imo.BypassDocumentValidation {
op = op.BypassDocumentValidation(*imo.BypassDocumentValidation)
}
if imo.Ordered != nil {
op = op.Ordered(*imo.Ordered)
}
retry := driver.RetryNone
if coll.client.retryWrites {
retry = driver.RetryOncePerCommand
}
op = op.Retry(retry)
return result, op.Execute(ctx)
}
// InsertOne inserts a single document into the collection.
func (coll *Collection) InsertOne(ctx context.Context, document interface{},
opts ...*options.InsertOneOptions) (*InsertOneResult, error) {
imOpts := make([]*options.InsertManyOptions, len(opts))
for i, opt := range opts {
imo := options.InsertMany()
if opt.BypassDocumentValidation != nil && *opt.BypassDocumentValidation {
imo = imo.SetBypassDocumentValidation(*opt.BypassDocumentValidation)
}
imOpts[i] = imo
}
res, err := coll.insert(ctx, []interface{}{document}, imOpts...)
rr, err := processWriteError(err)
if rr&rrOne == 0 {
return nil, err
}
return &InsertOneResult{InsertedID: res[0]}, err
}
// InsertMany inserts the provided documents.
func (coll *Collection) InsertMany(ctx context.Context, documents []interface{},
opts ...*options.InsertManyOptions) (*InsertManyResult, error) {
if len(documents) == 0 {
return nil, ErrEmptySlice
}
result, err := coll.insert(ctx, documents, opts...)
rr, err := processWriteError(err)
if rr&rrMany == 0 {
return nil, err
}
imResult := &InsertManyResult{InsertedIDs: result}
writeException, ok := err.(WriteException)
if !ok {
return imResult, err
}
// create and return a BulkWriteException
bwErrors := make([]BulkWriteError, 0, len(writeException.WriteErrors))
for _, we := range writeException.WriteErrors {
bwErrors = append(bwErrors, BulkWriteError{
WriteError{
Index: we.Index,
Code: we.Code,
Message: we.Message,
},
nil,
})
}
return imResult, BulkWriteException{
WriteErrors: bwErrors,
WriteConcernError: writeException.WriteConcernError,
}
}
func (coll *Collection) delete(ctx context.Context, filter interface{}, deleteOne bool, expectedRr returnResult,
opts ...*options.DeleteOptions) (*DeleteResult, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
defer sess.EndSession()
}
err = coll.client.validSession(sess)
if err != nil {
return nil, err
}
wc := coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !writeconcern.AckWrite(wc) {
sess = nil
}
selector := makePinnedSelector(sess, coll.writeSelector)
var limit int32
if deleteOne {
limit = 1
}
do := options.MergeDeleteOptions(opts...)
didx, doc := bsoncore.AppendDocumentStart(nil)
doc = bsoncore.AppendDocumentElement(doc, "q", f)
doc = bsoncore.AppendInt32Element(doc, "limit", limit)
if do.Collation != nil {
doc = bsoncore.AppendDocumentElement(doc, "collation", do.Collation.ToDocument())
}
doc, _ = bsoncore.AppendDocumentEnd(doc, didx)
op := operation.NewDelete(doc).
Session(sess).WriteConcern(wc).CommandMonitor(coll.client.monitor).
ServerSelector(selector).ClusterClock(coll.client.clock).
Database(coll.db.name).Collection(coll.name).
Deployment(coll.client.topology)
// deleteMany cannot be retried
retryMode := driver.RetryNone
if deleteOne && coll.client.retryWrites {
retryMode = driver.RetryOncePerCommand
}
op = op.Retry(retryMode)
rr, err := processWriteError(op.Execute(ctx))
if rr&expectedRr == 0 {
return nil, err
}
return &DeleteResult{DeletedCount: int64(op.Result().N)}, err
}
// DeleteOne deletes a single document from the collection.
func (coll *Collection) DeleteOne(ctx context.Context, filter interface{},
opts ...*options.DeleteOptions) (*DeleteResult, error) {
return coll.delete(ctx, filter, true, rrOne, opts...)
}
// DeleteMany deletes multiple documents from the collection.
func (coll *Collection) DeleteMany(ctx context.Context, filter interface{},
opts ...*options.DeleteOptions) (*DeleteResult, error) {
return coll.delete(ctx, filter, false, rrMany, opts...)
}
func (coll *Collection) updateOrReplace(ctx context.Context, filter bsoncore.Document, update interface{}, multi bool,
expectedRr returnResult, checkDollarKey bool, opts ...*options.UpdateOptions) (*UpdateResult, error) {
if ctx == nil {
ctx = context.Background()
}
uo := options.MergeUpdateOptions(opts...)
uidx, updateDoc := bsoncore.AppendDocumentStart(nil)
updateDoc = bsoncore.AppendDocumentElement(updateDoc, "q", filter)
u, err := transformUpdateValue(coll.registry, update, checkDollarKey)
if err != nil {
return nil, err
}
updateDoc = bsoncore.AppendValueElement(updateDoc, "u", u)
if multi {
updateDoc = bsoncore.AppendBooleanElement(updateDoc, "multi", multi)
}
// collation, arrayFilters, and upsert are included on the individual update documents rather than as part of the
// command
if uo.Collation != nil {
updateDoc = bsoncore.AppendDocumentElement(updateDoc, "collation", bsoncore.Document(uo.Collation.ToDocument()))
}
if uo.ArrayFilters != nil {
arr, err := uo.ArrayFilters.ToArrayDocument()
if err != nil {
return nil, err
}
updateDoc = bsoncore.AppendArrayElement(updateDoc, "arrayFilters", arr)
}
if uo.Upsert != nil {
updateDoc = bsoncore.AppendBooleanElement(updateDoc, "upsert", *uo.Upsert)
}
updateDoc, _ = bsoncore.AppendDocumentEnd(updateDoc, uidx)
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
var err error
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
defer sess.EndSession()
}
err = coll.client.validSession(sess)
if err != nil {
return nil, err
}
wc := coll.writeConcern
if sess.TransactionRunning() {
wc = nil
}
if !writeconcern.AckWrite(wc) {
sess = nil
}
selector := makePinnedSelector(sess, coll.writeSelector)
op := operation.NewUpdate(updateDoc).
Session(sess).WriteConcern(wc).CommandMonitor(coll.client.monitor).
ServerSelector(selector).ClusterClock(coll.client.clock).
Database(coll.db.name).Collection(coll.name).
Deployment(coll.client.topology)
if uo.BypassDocumentValidation != nil && *uo.BypassDocumentValidation {
op = op.BypassDocumentValidation(*uo.BypassDocumentValidation)
}
retry := driver.RetryNone
// retryable writes are only enabled updateOne/replaceOne operations
if !multi && coll.client.retryWrites {
retry = driver.RetryOncePerCommand
}
op = op.Retry(retry)
err = op.Execute(ctx)
rr, err := processWriteError(err)
if rr&expectedRr == 0 {
return nil, err
}
opRes := op.Result()
res := &UpdateResult{
MatchedCount: int64(opRes.N),
ModifiedCount: int64(opRes.NModified),
UpsertedCount: int64(len(opRes.Upserted)),
}
if len(opRes.Upserted) > 0 {
res.UpsertedID = opRes.Upserted[0].ID
res.MatchedCount--
}
return res, err
}
// UpdateOne updates a single document in the collection.
func (coll *Collection) UpdateOne(ctx context.Context, filter interface{}, update interface{},
opts ...*options.UpdateOptions) (*UpdateResult, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
return coll.updateOrReplace(ctx, f, update, false, rrOne, true, opts...)
}
// UpdateMany updates multiple documents in the collection.
func (coll *Collection) UpdateMany(ctx context.Context, filter interface{}, update interface{},
opts ...*options.UpdateOptions) (*UpdateResult, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
return coll.updateOrReplace(ctx, f, update, true, rrMany, true, opts...)
}
// ReplaceOne replaces a single document in the collection.
func (coll *Collection) ReplaceOne(ctx context.Context, filter interface{},
replacement interface{}, opts ...*options.ReplaceOptions) (*UpdateResult, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
r, err := transformBsoncoreDocument(coll.registry, replacement)
if err != nil {
return nil, err
}
if elem, err := r.IndexErr(0); err == nil && strings.HasPrefix(elem.Key(), "$") {
return nil, errors.New("replacement document cannot contains keys beginning with '$")
}
updateOptions := make([]*options.UpdateOptions, 0, len(opts))
for _, opt := range opts {
uOpts := options.Update()
uOpts.BypassDocumentValidation = opt.BypassDocumentValidation
uOpts.Collation = opt.Collation
uOpts.Upsert = opt.Upsert
updateOptions = append(updateOptions, uOpts)
}
return coll.updateOrReplace(ctx, f, r, false, rrOne, false, updateOptions...)
}
// Aggregate runs an aggregation framework pipeline.
//
// See https://docs.mongodb.com/manual/aggregation/.
func (coll *Collection) Aggregate(ctx context.Context, pipeline interface{},
opts ...*options.AggregateOptions) (*Cursor, error) {
a := aggregateParams{
ctx: ctx,
pipeline: pipeline,
client: coll.client,
registry: coll.registry,
readConcern: coll.readConcern,
writeConcern: coll.writeConcern,
retryRead: coll.client.retryReads,
db: coll.db.name,
col: coll.name,
readSelector: coll.readSelector,
writeSelector: coll.writeSelector,
readPreference: coll.readPreference,
opts: opts,
}
return aggregate(a)
}
// aggreate is the helper method for Aggregate
func aggregate(a aggregateParams) (*Cursor, error) {
if a.ctx == nil {
a.ctx = context.Background()
}
pipelineArr, hasOutputStage, err := transformAggregatePipelinev2(a.registry, a.pipeline)
if err != nil {
return nil, err
}
sess := sessionFromContext(a.ctx)
if sess == nil && a.client.topology.SessionPool != nil {
sess, err = session.NewClientSession(a.client.topology.SessionPool, a.client.id, session.Implicit)
if err != nil {
return nil, err
}
}
if err = a.client.validSession(sess); err != nil {
return nil, err
}
var wc *writeconcern.WriteConcern
if hasOutputStage {
wc = a.writeConcern
}
rc := a.readConcern
if sess.TransactionRunning() {
wc = nil
rc = nil
}
if !writeconcern.AckWrite(wc) {
closeImplicitSession(sess)
sess = nil
}
selector := makePinnedSelector(sess, a.writeSelector)
if !hasOutputStage {
selector = makeReadPrefSelector(sess, a.readSelector, a.client.localThreshold)
}
ao := options.MergeAggregateOptions(a.opts...)
cursorOpts := driver.CursorOptions{
CommandMonitor: a.client.monitor,
}
op := operation.NewAggregate(pipelineArr).Session(sess).WriteConcern(wc).ReadConcern(rc).ReadPreference(a.readPreference).CommandMonitor(a.client.monitor).
ServerSelector(selector).ClusterClock(a.client.clock).Database(a.db).Collection(a.col).Deployment(a.client.topology)
if ao.AllowDiskUse != nil {
op.AllowDiskUse(*ao.AllowDiskUse)
}
// ignore batchSize of 0 with $out
if ao.BatchSize != nil && !(*ao.BatchSize == 0 && hasOutputStage) {
op.BatchSize(*ao.BatchSize)
cursorOpts.BatchSize = *ao.BatchSize
}
if ao.BypassDocumentValidation != nil && *ao.BypassDocumentValidation {
op.BypassDocumentValidation(*ao.BypassDocumentValidation)
}
if ao.Collation != nil {
op.Collation(bsoncore.Document(ao.Collation.ToDocument()))
}
if ao.MaxTime != nil {
op.MaxTimeMS(int64(*ao.MaxTime / time.Millisecond))
}
if ao.MaxAwaitTime != nil {
cursorOpts.MaxTimeMS = int64(*ao.MaxAwaitTime / time.Millisecond)
}
if ao.Comment != nil {
op.Comment(*ao.Comment)
}
if ao.Hint != nil {
hintVal, err := transformValue(a.registry, ao.Hint)
if err != nil {
closeImplicitSession(sess)
return nil, err
}
op.Hint(hintVal)
}
retry := driver.RetryNone
if a.retryRead && !hasOutputStage {
retry = driver.RetryOncePerCommand
}
op = op.Retry(retry)
err = op.Execute(a.ctx)
if err != nil {
closeImplicitSession(sess)
if wce, ok := err.(driver.WriteCommandError); ok && wce.WriteConcernError != nil {
return nil, *convertDriverWriteConcernError(wce.WriteConcernError)
}
return nil, replaceErrors(err)
}
bc, err := op.Result(cursorOpts)
if err != nil {
closeImplicitSession(sess)
return nil, replaceErrors(err)
}
cursor, err := newCursorWithSession(bc, a.registry, sess)
return cursor, replaceErrors(err)
}
// CountDocuments gets the number of documents matching the filter.
// For a fast count of the total documents in a collection see EstimatedDocumentCount.
func (coll *Collection) CountDocuments(ctx context.Context, filter interface{},
opts ...*options.CountOptions) (int64, error) {
if ctx == nil {
ctx = context.Background()
}
countOpts := options.MergeCountOptions(opts...)
pipelineArr, err := countDocumentsAggregatePipeline(coll.registry, filter, countOpts)
if err != nil {
return 0, err
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return 0, err
}
defer sess.EndSession()
}
if err = coll.client.validSession(sess); err != nil {
return 0, err
}
rc := coll.readConcern
if sess.TransactionRunning() {
rc = nil
}
selector := makeReadPrefSelector(sess, coll.readSelector, coll.client.localThreshold)
op := operation.NewAggregate(pipelineArr).Session(sess).ReadConcern(rc).ReadPreference(coll.readPreference).
CommandMonitor(coll.client.monitor).ServerSelector(selector).ClusterClock(coll.client.clock).Database(coll.db.name).
Collection(coll.name).Deployment(coll.client.topology)
if countOpts.Collation != nil {
op.Collation(bsoncore.Document(countOpts.Collation.ToDocument()))
}
if countOpts.MaxTime != nil {
op.MaxTimeMS(int64(*countOpts.MaxTime / time.Millisecond))
}
if countOpts.Hint != nil {
hintVal, err := transformValue(coll.registry, countOpts.Hint)
if err != nil {
return 0, err
}
op.Hint(hintVal)
}
retry := driver.RetryNone
if coll.client.retryReads {
retry = driver.RetryOncePerCommand
}
op = op.Retry(retry)
err = op.Execute(ctx)
if err != nil {
return 0, replaceErrors(err)
}
batch := op.ResultCursorResponse().FirstBatch
if batch == nil {
return 0, errors.New("invalid response from server, no 'firstBatch' field")
}
docs, err := batch.Documents()
if err != nil || len(docs) == 0 {
return 0, nil
}
val, ok := docs[0].Lookup("n").AsInt64OK()
if !ok {
return 0, errors.New("invalid response from server, no 'n' field")
}
return val, nil
}
// EstimatedDocumentCount gets an estimate of the count of documents in a collection using collection metadata.
func (coll *Collection) EstimatedDocumentCount(ctx context.Context,
opts ...*options.EstimatedDocumentCountOptions) (int64, error) {
if ctx == nil {
ctx = context.Background()
}
sess := sessionFromContext(ctx)
var err error
if sess == nil && coll.client.topology.SessionPool != nil {
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return 0, err
}
defer sess.EndSession()
}
err = coll.client.validSession(sess)
if err != nil {
return 0, err
}
rc := coll.readConcern
if sess.TransactionRunning() {
rc = nil
}
selector := makeReadPrefSelector(sess, coll.readSelector, coll.client.localThreshold)
op := operation.NewCount().Session(sess).ClusterClock(coll.client.clock).
Database(coll.db.name).Collection(coll.name).CommandMonitor(coll.client.monitor).
Deployment(coll.client.topology).ReadConcern(rc).ReadPreference(coll.readPreference).
ServerSelector(selector)
co := options.MergeEstimatedDocumentCountOptions(opts...)
if co.MaxTime != nil {
op = op.MaxTimeMS(int64(*co.MaxTime / time.Millisecond))
}
retry := driver.RetryNone
if coll.client.retryReads {
retry = driver.RetryOncePerCommand
}
op.Retry(retry)
err = op.Execute(ctx)
return op.Result().N, replaceErrors(err)
}
// Distinct finds the distinct values for a specified field across a single
// collection.
func (coll *Collection) Distinct(ctx context.Context, fieldName string, filter interface{},
opts ...*options.DistinctOptions) ([]interface{}, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
defer sess.EndSession()
}
err = coll.client.validSession(sess)
if err != nil {
return nil, err
}
rc := coll.readConcern
if sess.TransactionRunning() {
rc = nil
}
selector := makeReadPrefSelector(sess, coll.readSelector, coll.client.localThreshold)
option := options.MergeDistinctOptions(opts...)
op := operation.NewDistinct(fieldName, bsoncore.Document(f)).
Session(sess).ClusterClock(coll.client.clock).
Database(coll.db.name).Collection(coll.name).CommandMonitor(coll.client.monitor).
Deployment(coll.client.topology).ReadConcern(rc).ReadPreference(coll.readPreference).
ServerSelector(selector)
if option.Collation != nil {
op.Collation(bsoncore.Document(option.Collation.ToDocument()))
}
if option.MaxTime != nil {
op.MaxTimeMS(int64(*option.MaxTime / time.Millisecond))
}
retry := driver.RetryNone
if coll.client.retryReads {
retry = driver.RetryOncePerCommand
}
op = op.Retry(retry)
err = op.Execute(ctx)
if err != nil {
return nil, replaceErrors(err)
}
arr, ok := op.Result().Values.ArrayOK()
if !ok {
return nil, fmt.Errorf("response field 'values' is type array, but received BSON type %s", op.Result().Values.Type)
}
values, err := arr.Values()
if err != nil {
return nil, err
}
retArray := make([]interface{}, len(values))
for i, val := range values {
raw := bson.RawValue{Type: val.Type, Value: val.Data}
err = raw.Unmarshal(&retArray[i])
if err != nil {
return nil, err
}
}
return retArray, replaceErrors(err)
}
// Find finds the documents matching a model.
func (coll *Collection) Find(ctx context.Context, filter interface{},
opts ...*options.FindOptions) (*Cursor, error) {
if ctx == nil {
ctx = context.Background()
}
f, err := transformBsoncoreDocument(coll.registry, filter)
if err != nil {
return nil, err
}
sess := sessionFromContext(ctx)
if sess == nil && coll.client.topology.SessionPool != nil {
var err error
sess, err = session.NewClientSession(coll.client.topology.SessionPool, coll.client.id, session.Implicit)
if err != nil {
return nil, err
}
}
err = coll.client.validSession(sess)
if err != nil {
closeImplicitSession(sess)
return nil, err
}
rc := coll.readConcern
if sess.TransactionRunning() {
rc = nil
}
selector := makeReadPrefSelector(sess, coll.readSelector, coll.client.localThreshold)
op := operation.NewFind(f).
Session(sess).ReadConcern(rc).ReadPreference(coll.readPreference).
CommandMonitor(coll.client.monitor).ServerSelector(selector).
ClusterClock(coll.client.clock).Database(coll.db.name).Collection(coll.name).
Deployment(coll.client.topology)
fo := options.MergeFindOptions(opts...)
cursorOpts := driver.CursorOptions{
CommandMonitor: coll.client.monitor,
}
if fo.AllowPartialResults != nil {
op.AllowPartialResults(*fo.AllowPartialResults)
}
if fo.BatchSize != nil {
cursorOpts.BatchSize = *fo.BatchSize
op.BatchSize(*fo.BatchSize)
}
if fo.Collation != nil {
op.Collation(bsoncore.Document(fo.Collation.ToDocument()))
}
if fo.Comment != nil {
op.Comment(*fo.Comment)
}
if fo.CursorType != nil {
switch *fo.CursorType {
case options.Tailable:
op.Tailable(true)
case options.TailableAwait:
op.Tailable(true)