Repository navigation
Expand file tree
/
Copy pathcollection.ts
More file actions
1341 lines (1253 loc) · 45.9 KB
/
Copy pathcollection.ts
File metadata and controls
1341 lines (1253 loc) · 45.9 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
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
import { type BSONSerializeOptions, type Document, resolveBSONOptions } from './bson';
import type {
AnyBulkWriteOperation,
BulkOperationBase,
BulkWriteOptions,
BulkWriteResult
} from './bulk/common';
import { OrderedBulkOperation } from './bulk/ordered';
import { UnorderedBulkOperation } from './bulk/unordered';
import { ChangeStream, type ChangeStreamDocument, type ChangeStreamOptions } from './change_stream';
import { AggregationCursor } from './cursor/aggregation_cursor';
import { FindCursor } from './cursor/find_cursor';
import { ListIndexesCursor } from './cursor/list_indexes_cursor';
import {
ListSearchIndexesCursor,
type ListSearchIndexesOptions
} from './cursor/list_search_indexes_cursor';
import type { Db } from './db';
import {
isNamespaceNotFoundError,
MongoAPIError,
MongoInvalidArgumentError,
MongoServerError
} from './error';
import { type ExplainCommandOptions, type ExplainVerbosityLike } from './explain';
import type { MongoClient, PkFactory } from './mongo_client';
import type {
Abortable,
Filter,
Flatten,
OptionalUnlessRequiredId,
TODO_NODE_3286,
UpdateFilter,
WithId,
WithoutId
} from './mongo_types';
import type { AggregateOptions } from './operations/aggregate';
import { CountOperation, type CountOptions } from './operations/count';
import {
DeleteManyOperation,
DeleteOneOperation,
type DeleteOptions,
type DeleteResult
} from './operations/delete';
import { DistinctOperation, type DistinctOptions } from './operations/distinct';
import { type DropCollectionOptions } from './operations/drop';
import {
EstimatedDocumentCountOperation,
type EstimatedDocumentCountOptions
} from './operations/estimated_document_count';
import { autoConnect, executeOperation } from './operations/execute_operation';
import { type FindOneOptions, type FindOptions } from './operations/find';
import {
FindOneAndDeleteOperation,
type FindOneAndDeleteOptions,
FindOneAndReplaceOperation,
type FindOneAndReplaceOptions,
FindOneAndUpdateOperation,
type FindOneAndUpdateOptions
} from './operations/find_and_modify';
import {
CreateIndexesOperation,
type CreateIndexesOptions,
type CreateIndexOptions,
type DropIndexesOptions,
DropIndexOperation,
type IndexDescription,
type IndexDescriptionCompact,
type IndexDescriptionInfo,
type IndexInformationOptions,
type IndexOptions,
type IndexSpecification,
type ListIndexesOptions
} from './operations/indexes';
import {
type InsertManyResult,
InsertOneOperation,
type InsertOneOptions,
type InsertOneResult
} from './operations/insert';
import type { Hint, OperationOptions } from './operations/operation';
import { RenameOperation, type RenameOptions } from './operations/rename';
import {
CreateSearchIndexesOperation,
type SearchIndexDescription
} from './operations/search_indexes/create';
import { DropSearchIndexOperation } from './operations/search_indexes/drop';
import { UpdateSearchIndexOperation } from './operations/search_indexes/update';
import {
ReplaceOneOperation,
type ReplaceOptions,
UpdateManyOperation,
UpdateOneOperation,
type UpdateOptions,
type UpdateResult
} from './operations/update';
import { ReadConcern, type ReadConcernLike } from './read_concern';
import { ReadPreference, type ReadPreferenceLike } from './read_preference';
import { type Sort } from './sort';
import {
DEFAULT_PK_FACTORY,
MongoDBCollectionNamespace,
normalizeHintField,
resolveOptions
} from './utils';
import { WriteConcern, type WriteConcernOptions } from './write_concern';
/** @public */
export interface ModifyResult<TSchema = Document> {
value: WithId<TSchema> | null;
lastErrorObject?: Document;
ok: 0 | 1;
}
/** @public */
export interface CountDocumentsOptions extends AggregateOptions {
/** The number of documents to skip. */
skip?: number;
/** The maximum amount of documents to consider. */
limit?: number;
}
/** @public */
export interface CollectionOptions extends BSONSerializeOptions, WriteConcernOptions {
/** Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) */
readConcern?: ReadConcernLike;
/** The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). */
readPreference?: ReadPreferenceLike;
/**
* Specifies the time an operation will run until it throws a timeout error
* @deprecated `timeoutMS` has no effect and will be removed in a future release.
*/
timeoutMS?: number;
}
/** @internal */
export interface CollectionPrivate {
pkFactory: PkFactory;
db: Db;
options: any;
namespace: MongoDBCollectionNamespace;
readPreference?: ReadPreference;
bsonOptions: BSONSerializeOptions;
collectionHint?: Hint;
readConcern?: ReadConcern;
writeConcern?: WriteConcern;
}
/**
* The **Collection** class is an internal class that embodies a MongoDB collection
* allowing for insert/find/update/delete and other command operation on that MongoDB collection.
*
* **COLLECTION Cannot directly be instantiated**
* @public
*
* @example
* ```ts
* import { MongoClient } from 'mongodb';
*
* interface Pet {
* name: string;
* kind: 'dog' | 'cat' | 'fish';
* }
*
* const client = new MongoClient('mongodb://localhost:27017');
* const pets = client.db().collection<Pet>('pets');
*
* const petCursor = pets.find();
*
* for await (const pet of petCursor) {
* console.log(`${pet.name} is a ${pet.kind}!`);
* }
* ```
*/
export class Collection<TSchema extends Document = Document> {
/** @internal */
s: CollectionPrivate;
/** @internal */
client: MongoClient;
/**
* Get the database object for the collection.
*/
readonly db: Db;
/**
* Create a new Collection instance
* @internal
*/
constructor(db: Db, name: string, options?: CollectionOptions) {
this.db = db;
// Internal state
this.s = {
db,
options,
namespace: new MongoDBCollectionNamespace(db.databaseName, name),
pkFactory: db.options?.pkFactory ?? DEFAULT_PK_FACTORY,
readPreference: ReadPreference.fromOptions(options),
bsonOptions: resolveBSONOptions(options, db),
readConcern: ReadConcern.fromOptions(options),
writeConcern: WriteConcern.fromOptions(options)
};
this.client = db.client;
}
/**
* The name of the database this collection belongs to
*/
get dbName(): string {
return this.s.namespace.db;
}
/**
* The name of this collection
*/
get collectionName(): string {
return this.s.namespace.collection;
}
/**
* The namespace of this collection, in the format `${this.dbName}.${this.collectionName}`
*/
get namespace(): string {
return this.fullNamespace.toString();
}
/**
* @internal
*
* The `MongoDBNamespace` for the collection.
*/
get fullNamespace(): MongoDBCollectionNamespace {
return this.s.namespace;
}
/**
* The current readConcern of the collection. If not explicitly defined for
* this collection, will be inherited from the parent DB
*/
get readConcern(): ReadConcern | undefined {
if (this.s.readConcern == null) {
return this.db.readConcern;
}
return this.s.readConcern;
}
/**
* The current readPreference of the collection. If not explicitly defined for
* this collection, will be inherited from the parent DB
*/
get readPreference(): ReadPreference | undefined {
if (this.s.readPreference == null) {
return this.db.readPreference;
}
return this.s.readPreference;
}
get bsonOptions(): BSONSerializeOptions {
return this.s.bsonOptions;
}
/**
* The current writeConcern of the collection. If not explicitly defined for
* this collection, will be inherited from the parent DB
*/
get writeConcern(): WriteConcern | undefined {
if (this.s.writeConcern == null) {
return this.db.writeConcern;
}
return this.s.writeConcern;
}
/** The current index hint for the collection */
get hint(): Hint | undefined {
return this.s.collectionHint;
}
set hint(v: Hint | undefined) {
this.s.collectionHint = normalizeHintField(v);
}
/** @deprecated `timeoutMS` has no effect and will be removed in a future release. */
public get timeoutMS(): number | undefined {
return undefined;
}
/**
* Inserts a single document into MongoDB. If documents passed in do not contain the **_id** field,
* one will be added to each of the documents missing it by the driver, mutating the document. This behavior
* can be overridden by setting the **forceServerObjectId** flag.
*
* @param doc - The document to insert
* @param options - Optional settings for the command
*/
async insertOne(
doc: OptionalUnlessRequiredId<TSchema>,
options?: InsertOneOptions
): Promise<InsertOneResult<TSchema>> {
return await executeOperation(
this.client,
new InsertOneOperation(
this as TODO_NODE_3286,
doc,
resolveOptions(this, options)
) as TODO_NODE_3286
);
}
/**
* Inserts an array of documents into MongoDB. If documents passed in do not contain the **_id** field,
* one will be added to each of the documents missing it by the driver, mutating the document. This behavior
* can be overridden by setting the **forceServerObjectId** flag.
*
* @param docs - The documents to insert
* @param options - Optional settings for the command
*/
async insertMany(
docs: ReadonlyArray<OptionalUnlessRequiredId<TSchema>>,
options?: BulkWriteOptions
): Promise<InsertManyResult<TSchema>> {
if (!Array.isArray(docs)) {
throw new MongoInvalidArgumentError('Argument "docs" must be an array of documents');
}
options = resolveOptions(this, options ?? {});
const acknowledged = WriteConcern.fromOptions(options)?.w !== 0;
try {
const res = await this.bulkWrite(
docs.map(doc => ({ insertOne: { document: doc } })),
options
);
return {
acknowledged,
insertedCount: res.insertedCount,
insertedIds: res.insertedIds
};
} catch (err) {
if (err && err.message === 'Operation must be an object with an operation key') {
throw new MongoInvalidArgumentError(
'Collection.insertMany() cannot be called with an array that has null/undefined values'
);
}
throw err;
}
}
/**
* Perform a bulkWrite operation without a fluent API
*
* Legal operation types are
* - `insertOne`
* - `replaceOne`
* - `updateOne`
* - `updateMany`
* - `deleteOne`
* - `deleteMany`
*
* If documents passed in do not contain the **_id** field,
* one will be added to each of the documents missing it by the driver, mutating the document. This behavior
* can be overridden by setting the **forceServerObjectId** flag.
*
* @param operations - Bulk operations to perform
* @param options - Optional settings for the command
* @throws MongoDriverError if operations is not an array
*/
async bulkWrite(
operations: ReadonlyArray<AnyBulkWriteOperation<TSchema>>,
options?: BulkWriteOptions
): Promise<BulkWriteResult> {
if (!Array.isArray(operations)) {
throw new MongoInvalidArgumentError('Argument "operations" must be an array of documents');
}
options = resolveOptions(this, options ?? {});
// TODO(NODE-7071): remove once the client doesn't need to be connected to construct
// bulk operations
const isConnected = this.client.topology != null;
if (!isConnected) {
await autoConnect(this.client);
}
// Create the bulk operation
const bulk: BulkOperationBase =
options.ordered === false
? this.initializeUnorderedBulkOp(options)
: this.initializeOrderedBulkOp(options);
// for each op go through and add to the bulk
for (const operation of operations) {
bulk.raw(operation);
}
// Execute the bulk
return await bulk.execute({ ...options });
}
/**
* Update a single document in a collection
*
* The value of `update` can be either:
* - UpdateFilter<TSchema> - A document that contains update operator expressions,
* - Document[] - an aggregation pipeline.
*
* @param filter - The filter used to select the document to update
* @param update - The modifications to apply
* @param options - Optional settings for the command
*/
async updateOne(
filter: Filter<TSchema>,
update: UpdateFilter<TSchema> | Document[],
options?: UpdateOptions & { sort?: Sort }
): Promise<UpdateResult<TSchema>> {
return await executeOperation(
this.client,
new UpdateOneOperation(this.s.namespace, filter, update, resolveOptions(this, options))
);
}
/**
* Replace a document in a collection with another document
*
* @param filter - The filter used to select the document to replace
* @param replacement - The Document that replaces the matching document
* @param options - Optional settings for the command
*/
async replaceOne(
filter: Filter<TSchema>,
replacement: WithoutId<TSchema>,
options?: ReplaceOptions
): Promise<UpdateResult<TSchema>> {
return await executeOperation(
this.client,
new ReplaceOneOperation(this.s.namespace, filter, replacement, resolveOptions(this, options))
);
}
/**
* Update multiple documents in a collection
*
* The value of `update` can be either:
* - UpdateFilter<TSchema> - A document that contains update operator expressions,
* - Document[] - an aggregation pipeline.
*
* @param filter - The filter used to select the document to update
* @param update - The modifications to apply
* @param options - Optional settings for the command
*/
async updateMany(
filter: Filter<TSchema>,
update: UpdateFilter<TSchema> | Document[],
options?: UpdateOptions
): Promise<UpdateResult<TSchema>> {
return await executeOperation(
this.client,
new UpdateManyOperation(this.s.namespace, filter, update, resolveOptions(this, options))
);
}
/**
* Delete a document from a collection
*
* @param filter - The filter used to select the document to remove
* @param options - Optional settings for the command
*/
async deleteOne(
filter: Filter<TSchema> = {},
options: DeleteOptions = {}
): Promise<DeleteResult> {
return await executeOperation(
this.client,
new DeleteOneOperation(this.s.namespace, filter, resolveOptions(this, options))
);
}
/**
* Delete multiple documents from a collection
*
* @param filter - The filter used to select the documents to remove
* @param options - Optional settings for the command
*/
async deleteMany(
filter: Filter<TSchema> = {},
options: DeleteOptions = {}
): Promise<DeleteResult> {
return await executeOperation(
this.client,
new DeleteManyOperation(this.s.namespace, filter, resolveOptions(this, options))
);
}
/**
* Rename the collection.
*
* @remarks
* This operation does not inherit options from the Db or MongoClient.
*
* @param newName - New name of of the collection.
* @param options - Optional settings for the command
*/
async rename(newName: string, options?: RenameOptions): Promise<Collection> {
// Intentionally, we do not inherit options from parent for this operation.
return await executeOperation(
this.client,
new RenameOperation(
this as TODO_NODE_3286,
newName,
resolveOptions(undefined, {
...options,
readPreference: ReadPreference.PRIMARY
})
)
);
}
/**
* Drop the collection from the database, removing it permanently. New accesses will create a new collection.
*
* @param options - Optional settings for the command
*/
async drop(options?: DropCollectionOptions): Promise<boolean> {
return await this.db.dropCollection(this.collectionName, options);
}
/**
* Fetches the first document that matches the filter
*
* @param filter - Query for find Operation
* @param options - Optional settings for the command
*/
async findOne(): Promise<WithId<TSchema> | null>;
async findOne(filter: Filter<TSchema>): Promise<WithId<TSchema> | null>;
async findOne(
filter: Filter<TSchema>,
options: Omit<FindOneOptions, 'timeoutMode'> & Abortable
): Promise<WithId<TSchema> | null>;
// allow an override of the schema.
async findOne<T = TSchema>(): Promise<T | null>;
async findOne<T = TSchema>(filter: Filter<TSchema>): Promise<T | null>;
async findOne<T = TSchema>(
filter: Filter<TSchema>,
options?: Omit<FindOneOptions, 'timeoutMode'> & Abortable
): Promise<T | null>;
async findOne(
filter: Filter<TSchema> = {},
options: Omit<FindOneOptions, 'timeoutMode'> & Abortable = {}
): Promise<WithId<TSchema> | null> {
// Explicitly set the limit to 1 and singleBatch to true for all commands, per the spec.
// noCursorTimeout must be unset as well as batchSize.
// See: https://github.com/mongodb/specifications/blob/master/source/crud/crud.md#findone-api-details
const { ...opts } = options;
opts.singleBatch = true;
const cursor = this.find(filter, opts).limit(1);
const result = await cursor.next();
await cursor.close();
return result;
}
/**
* Creates a cursor for a filter that can be used to iterate over results from MongoDB
*
* @param filter - The filter predicate. If unspecified, then all documents in the collection will match the predicate
*/
find(): FindCursor<WithId<TSchema>>;
find(filter: Filter<TSchema>, options?: FindOptions & Abortable): FindCursor<WithId<TSchema>>;
find<T extends Document>(
filter: Filter<TSchema>,
options?: FindOptions & Abortable
): FindCursor<T>;
find(
filter: Filter<TSchema> = {},
options: FindOptions & Abortable = {}
): FindCursor<WithId<TSchema>> {
return new FindCursor<WithId<TSchema>>(
this.client,
this.s.namespace,
filter,
resolveOptions(this, options)
);
}
/**
* Returns the options of the collection.
*
* @param options - Optional settings for the command
*/
async options(options?: OperationOptions): Promise<Document> {
options = resolveOptions(this, options);
const [collection] = await this.db
.listCollections({ name: this.collectionName }, { ...options, nameOnly: false })
.toArray();
if (collection == null || collection.options == null) {
throw new MongoAPIError(`collection ${this.namespace} not found`);
}
return collection.options;
}
/**
* Returns if the collection is a capped collection
*
* @param options - Optional settings for the command
*/
async isCapped(options?: OperationOptions): Promise<boolean> {
const { capped } = await this.options(options);
return Boolean(capped);
}
/**
* Creates an index on the db and collection collection.
*
* @param indexSpec - The field name or index specification to create an index for
*
* @example
* ```ts
* const collection = client.db('foo').collection('bar');
*
* await collection.createIndex({ a: 1, b: -1 });
*
* // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
* await collection.createIndex([ [c, 1], [d, -1] ]);
*
* // Equivalent to { e: 1 }
* await collection.createIndex('e');
*
* // Equivalent to { f: 1, g: 1 }
* await collection.createIndex(['f', 'g'])
*
* // Equivalent to { h: 1, i: -1 }
* await collection.createIndex([ { h: 1 }, { i: -1 } ]);
*
* // Equivalent to { j: 1, k: -1, l: 2d }
* await collection.createIndex(['j', ['k', -1], { l: '2d' }])
* ```
*/
createIndex(indexSpec: IndexSpecification): Promise<string>;
/**
* Creates an index on the db and collection collection.
*
* @param indexSpec - The field name or index specification to create an index for
* @param options - Settings for the index and the `createIndexes` command combined
*
* @deprecated Use the three parameter overload, which separates index options from
* command options. This overload will be removed in a future major release.
*/
createIndex(
indexSpec: IndexSpecification,
options: CreateIndexesOptions | undefined
): Promise<string>;
/**
* Creates an index on the db and collection collection.
*
* Options for the index itself are given in `indexOptions`, and options for the
* `createIndexes` command are given separately in `commandOptions`. Unknown fields in
* `indexOptions` are passed through to the server for validation rather than being dropped.
*
* @param keys - The field name or index specification to create an index for
* @param indexOptions - Settings for the index, or `undefined` if there are none
* @param commandOptions - Settings for the `createIndexes` command, or `undefined` if there are none
*/
createIndex(
keys: IndexSpecification,
indexOptions: IndexOptions | undefined,
commandOptions: CreateIndexOptions | undefined
): Promise<string>;
async createIndex(
indexSpec: IndexSpecification,
indexOptions?: CreateIndexesOptions | IndexOptions,
commandOptions?: CreateIndexOptions
): Promise<string> {
// When commandOptions is provided the caller has separated the two kinds of options, so the
// index options are forwarded as-is and only the command options inherit from the parent.
// Otherwise indexOptions is both, and it inherits from the parent as it always has.
const operation =
commandOptions == null
? CreateIndexesOperation.fromIndexSpecification(
this,
this.collectionName,
indexSpec,
false,
resolveOptions(this, indexOptions), // at this point indexOptions is the combined index and command options
undefined
)
: CreateIndexesOperation.fromIndexSpecification(
this,
this.collectionName,
indexSpec,
true,
indexOptions,
resolveOptions(this, commandOptions)
);
const indexes = await executeOperation(this.client, operation);
return indexes[0];
}
/**
* Creates multiple indexes in the collection, this method is only supported for
* MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
* error.
*
* **Note**: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications.
* Index specifications are defined {@link https://www.mongodb.com/docs/manual/reference/command/createIndexes/| here}.
*
* @param indexSpecs - An array of index specifications to be created
* @param commandOptions - Optional settings for the `createIndexes` command
*
* @example
* ```ts
* const collection = client.db('foo').collection('bar');
* await collection.createIndexes([
* // Simple index on field fizz
* {
* key: { fizz: 1 },
* }
* // wildcard index
* {
* key: { '$**': 1 }
* },
* // named index on darmok and jalad
* {
* key: { darmok: 1, jalad: -1 }
* name: 'tanagra'
* }
* ]);
* ```
*/
createIndexes(
indexSpecs: IndexDescription[],
commandOptions?: CreateIndexesOptions
): Promise<string[]>;
/**
* Creates multiple indexes in the collection, opting into "pass through" behavior for index
* options the driver does not recognise.
*
* @param indexSpecs - An array of index specifications to be created
* @param commandOptions - Optional settings for the `createIndexes` command
* @param allowUnknownIndexOptions - When `true`, index options the driver does not recognise are
* sent to the server instead of being dropped, for the server to validate.
*
* @deprecated Used to opt into "pass through" behavior, where options will be validated by the
* server rather than the driver. In a future release this overload will be removed and the
* default behavior will change from `false` to `true`.
*/
createIndexes(
indexSpecs: IndexDescription[],
commandOptions: CreateIndexesOptions | undefined,
allowUnknownIndexOptions: boolean
): Promise<string[]>;
async createIndexes(
indexSpecs: IndexDescription[],
commandOptions?: CreateIndexesOptions,
// TODO(NODE-7868): Remove allowUnknownIndexOptions with a default behavior of true in a future major version release
allowUnknownIndexOptions = false
): Promise<string[]> {
return await executeOperation(
this.client,
CreateIndexesOperation.fromIndexDescriptionArray(
this,
this.collectionName,
indexSpecs,
// TODO(NODE-7868): Remove allowUnknownIndexOptions with a default behavior of true in a future major version release
allowUnknownIndexOptions,
resolveOptions(this, { ...commandOptions, maxTimeMS: undefined })
)
);
}
/**
* Drops an index from this collection.
*
* @param indexName - Name of the index to drop.
* @param options - Optional settings for the command
*/
async dropIndex(indexName: string, options?: DropIndexesOptions): Promise<Document> {
return await executeOperation(
this.client,
new DropIndexOperation(this as TODO_NODE_3286, indexName, {
...resolveOptions(this, options),
readPreference: ReadPreference.primary
})
);
}
/**
* Drops all indexes from this collection.
*
* @param options - Optional settings for the command
*/
async dropIndexes(options?: DropIndexesOptions): Promise<boolean> {
try {
await executeOperation(
this.client,
new DropIndexOperation(this as TODO_NODE_3286, '*', resolveOptions(this, options))
);
return true;
} catch (error) {
if (error instanceof MongoServerError && isNamespaceNotFoundError(error)) return false;
throw error;
}
}
/**
* Get the list of all indexes information for the collection.
*
* @param options - Optional settings for the command
*/
listIndexes(options?: ListIndexesOptions): ListIndexesCursor {
return new ListIndexesCursor(this as TODO_NODE_3286, resolveOptions(this, options));
}
/**
* Checks if one or more indexes exist on the collection, fails on first non-existing index
*
* @param indexes - One or more index names to check.
* @param options - Optional settings for the command
*/
async indexExists(indexes: string | string[], options?: ListIndexesOptions): Promise<boolean> {
const indexNames: string[] = Array.isArray(indexes) ? indexes : [indexes];
const allIndexes: Set<string> = new Set(
await this.listIndexes(options)
.map(({ name }) => name)
.toArray()
);
return indexNames.every(name => allIndexes.has(name));
}
/**
* Retrieves this collections index info.
*
* @param options - Optional settings for the command
*/
indexInformation(
options: IndexInformationOptions & { full: true }
): Promise<IndexDescriptionInfo[]>;
indexInformation(
options: IndexInformationOptions & { full?: false }
): Promise<IndexDescriptionCompact>;
indexInformation(
options: IndexInformationOptions
): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>;
indexInformation(): Promise<IndexDescriptionCompact>;
async indexInformation(
options?: IndexInformationOptions
): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]> {
return await this.indexes({
...options,
full: options?.full ?? false
});
}
/**
* Gets an estimate of the count of documents in a collection using collection metadata.
* This will always run a count command on all server versions.
*
* due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command,
* which estimatedDocumentCount uses in its implementation, was not included in v1 of
* the Stable API, and so users of the Stable API with estimatedDocumentCount are
* recommended to upgrade their server version to 5.0.9+ or set apiStrict: false to avoid
* encountering errors.
*
* @see {@link https://www.mongodb.com/docs/manual/reference/command/count/#behavior|Count: Behavior}
* @param options - Optional settings for the command
*/
async estimatedDocumentCount(options?: EstimatedDocumentCountOptions): Promise<number> {
return await executeOperation(
this.client,
new EstimatedDocumentCountOperation(this as TODO_NODE_3286, resolveOptions(this, options))
);
}
/**
* Gets the number of documents matching the filter.
* For a fast count of the total documents in a collection see {@link Collection#estimatedDocumentCount| estimatedDocumentCount}.
*
* Due to countDocuments using the $match aggregation pipeline stage, certain query operators cannot be used in countDocuments. This includes the $where and $near query operators, among others. Details can be found in the documentation for the $match aggregation pipeline stage.
*
* **Note**: When migrating from {@link Collection#count| count} to {@link Collection#countDocuments| countDocuments}
* the following query operators must be replaced:
*
* | Operator | Replacement |
* | -------- | ----------- |
* | `$where` | [`$expr`][1] |
* | `$near` | [`$geoWithin`][2] with [`$center`][3] |
* | `$nearSphere` | [`$geoWithin`][2] with [`$centerSphere`][4] |
*
* [1]: https://www.mongodb.com/docs/manual/reference/operator/query/expr/
* [2]: https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
* [3]: https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center
* [4]: https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere
*
* @param filter - The filter for the count
* @param options - Optional settings for the command
*
* @see https://www.mongodb.com/docs/manual/reference/operator/query/expr/
* @see https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/
* @see https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center
* @see https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere
*/
async countDocuments(
filter: Filter<TSchema> = {},
options: CountDocumentsOptions & Abortable = {}
): Promise<number> {
const pipeline = [];
pipeline.push({ $match: filter });
if (typeof options.skip === 'number') {
pipeline.push({ $skip: options.skip });
}
if (typeof options.limit === 'number') {
pipeline.push({ $limit: options.limit });
}
pipeline.push({ $group: { _id: 1, n: { $sum: 1 } } });
const cursor = this.aggregate<{ n: number }>(pipeline, options);
const doc = await cursor.next();
await cursor.close();
return doc?.n ?? 0;
}
/**
* The distinct command returns a list of distinct values for the given key across a collection.
*
* @param key - Field of the document to find distinct values for
* @param filter - The filter for filtering the set of documents to which we apply the distinct filter.
* @param options - Optional settings for the command
*/
distinct<Key extends keyof WithId<TSchema>>(
key: Key
): Promise<Array<Flatten<WithId<TSchema>[Key]>>>;
distinct<Key extends keyof WithId<TSchema>>(
key: Key,
filter: Filter<TSchema>
): Promise<Array<Flatten<WithId<TSchema>[Key]>>>;
distinct<Key extends keyof WithId<TSchema>>(
key: Key,
filter: Filter<TSchema>,
options: DistinctOptions
): Promise<Array<Flatten<WithId<TSchema>[Key]>>>;
distinct<Key extends keyof WithId<TSchema>>(
key: Key,
filter: Filter<TSchema>,
options: DistinctOptions & { explain: ExplainVerbosityLike | ExplainCommandOptions }
): Promise<Document>;
// Embedded documents overload
distinct(key: string): Promise<any[]>;
distinct(key: string, filter: Filter<TSchema>): Promise<any[]>;
distinct(key: string, filter: Filter<TSchema>, options: DistinctOptions): Promise<any[]>;
async distinct<Key extends keyof WithId<TSchema>>(
key: Key,
filter: Filter<TSchema> = {},
options: DistinctOptions = {}
): Promise<any[]> {
return await executeOperation(
this.client,
new DistinctOperation(
this as TODO_NODE_3286,
key as TODO_NODE_3286,
filter,
resolveOptions(this, options)
)
);
}
/**
* Retrieve all the indexes on the collection.
*
* @param options - Optional settings for the command
*/
indexes(options: IndexInformationOptions & { full?: true }): Promise<IndexDescriptionInfo[]>;
indexes(options: IndexInformationOptions & { full: false }): Promise<IndexDescriptionCompact>;
indexes(
options: IndexInformationOptions
): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>;
indexes(options?: ListIndexesOptions): Promise<IndexDescriptionInfo[]>;
async indexes(
options?: IndexInformationOptions
): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]> {
const indexes: IndexDescriptionInfo[] = await this.listIndexes(options).toArray();
const full = options?.full ?? true;
if (full) {
return indexes;
}