Collection | mongodb (original) (raw)

aggregate

• aggregate<T>(pipeline?, options?): AggregationCursor<T>

• Type Parameters

  • T extends Document = Document

Returns AggregationCursor<T>

bulkWrite

• bulkWrite(operations, options?): Promise<BulkWriteResult>

• Returns Promise<BulkWriteResult>

count

• count(filter?, options?): Promise<number>

• Returns Promise<number>

countDocuments

• countDocuments(filter?, options?): Promise<number>

• Returns Promise<number>

createIndex

• createIndex(indexSpec, options?): Promise<string>

• Returns Promise<string>

createIndexes

• createIndexes(indexSpecs, options?): Promise<string[]>

• Returns Promise<string[]>

createSearchIndex

• createSearchIndex(description): Promise<string>

• Returns Promise<string>

A promise that resolves to the name of the new search index.

createSearchIndexes

• createSearchIndexes(descriptions): Promise<string[]>

• Returns Promise<string[]>

A promise that resolves to an array of the newly created search index names.

deleteMany

• deleteMany(filter?, options?): Promise<DeleteResult>

• Returns Promise<DeleteResult>

deleteOne

• deleteOne(filter?, options?): Promise<DeleteResult>

• Returns Promise<DeleteResult>

distinct

• distinct<Key>(key): Promise<Flatten<WithId<TSchema>[Key]>[]>

• Type Parameters

  • Key extends string | number | symbol

Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

• distinct<Key>(key, filter): Promise<Flatten<WithId<TSchema>[Key]>[]>

• Type Parameters

  • Key extends string | number | symbol

Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

• distinct<Key>(key, filter, options): Promise<Flatten<WithId<TSchema>[Key]>[]>

• Type Parameters

  • Key extends string | number | symbol

Returns Promise<Flatten<WithId<TSchema>[Key]>[]>

• distinct(key): Promise<any[]>

• Returns Promise<any[]>

• distinct(key, filter): Promise<any[]>

• Returns Promise<any[]>

• distinct(key, filter, options): Promise<any[]>

• Returns Promise<any[]>

drop

• drop(options?): Promise<boolean>

• Returns Promise<boolean>

dropIndex

• dropIndex(indexName, options?): Promise<Document>

• Returns Promise<Document>

dropIndexes

• dropIndexes(options?): Promise<boolean>

• Returns Promise<boolean>

dropSearchIndex

• dropSearchIndex(name): Promise<void>

• Returns Promise<void>

estimatedDocumentCount

• estimatedDocumentCount(options?): Promise<number>

• Returns Promise<number>

find

• find(): FindCursor<WithId<TSchema>>

• Returns FindCursor<WithId<TSchema>>

• find(filter, options?): FindCursor<WithId<TSchema>>

• Returns FindCursor<WithId<TSchema>>

• find<T>(filter, options?): FindCursor<T>

• Type Parameters

  • T extends Document

Returns FindCursor<T>

findOne

• findOne(): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

• findOne(filter): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

• findOne(filter, options): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

• findOne<T>(): Promise<null | T>

• Type Parameters

  • T = TSchema

Returns Promise<null | T>

• findOne<T>(filter): Promise<null | T>

• Type Parameters

  • T = TSchema

Returns Promise<null | T>

• findOne<T>(filter, options?): Promise<null | T>

• Type Parameters

  • T = TSchema

Parameters

• filter: Filter<TSchema>
• Optionaloptions: Omit<FindOptions<Document>, "timeoutMode"> & Abortable

Returns Promise<null | T>

findOneAndDelete

• findOneAndDelete(filter, options): Promise<ModifyResult<TSchema>>

• Returns Promise<ModifyResult<TSchema>>

• findOneAndDelete(filter, options): Promise<null | WithId<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • options: FindOneAndDeleteOptions & {
    includeResultMetadata: false;
    }

Returns Promise<null | WithId<TSchema>>

• findOneAndDelete(filter, options): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

• findOneAndDelete(filter): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

findOneAndReplace

• findOneAndReplace(filter, replacement, options): Promise<ModifyResult<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • replacement: WithoutId<TSchema>
  • options: FindOneAndReplaceOptions & {
    includeResultMetadata: true;
    }

Returns Promise<ModifyResult<TSchema>>

• findOneAndReplace(filter, replacement, options): Promise<null | WithId<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • replacement: WithoutId<TSchema>
  • options: FindOneAndReplaceOptions & {
    includeResultMetadata: false;
    }

Returns Promise<null | WithId<TSchema>>

• findOneAndReplace(filter, replacement, options): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

• findOneAndReplace(filter, replacement): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

findOneAndUpdate

• findOneAndUpdate(filter, update, options): Promise<ModifyResult<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • update: Document[] | UpdateFilter<TSchema>
  • options: FindOneAndUpdateOptions & {
    includeResultMetadata: true;
    }

Returns Promise<ModifyResult<TSchema>>

• findOneAndUpdate(filter, update, options): Promise<null | WithId<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • update: Document[] | UpdateFilter<TSchema>
  • options: FindOneAndUpdateOptions & {
    includeResultMetadata: false;
    }

Returns Promise<null | WithId<TSchema>>

• findOneAndUpdate(filter, update, options): Promise<null | WithId<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • update: Document[] | UpdateFilter<TSchema>
  • options: FindOneAndUpdateOptions

Returns Promise<null | WithId<TSchema>>

• findOneAndUpdate(filter, update): Promise<null | WithId<TSchema>>

• Returns Promise<null | WithId<TSchema>>

indexes

• indexes(options): Promise<IndexDescriptionInfo[]>

• Returns Promise<IndexDescriptionInfo[]>

• indexes(options): Promise<IndexDescriptionCompact>

• Returns Promise<IndexDescriptionCompact>

• indexes(options): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>

• Returns Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>

• indexes(options?): Promise<IndexDescriptionInfo[]>

• Returns Promise<IndexDescriptionInfo[]>

indexExists

• indexExists(indexes, options?): Promise<boolean>

• Returns Promise<boolean>

indexInformation

• indexInformation(options): Promise<IndexDescriptionInfo[]>

• Returns Promise<IndexDescriptionInfo[]>

• indexInformation(options): Promise<IndexDescriptionCompact>

• Returns Promise<IndexDescriptionCompact>

• indexInformation(options): Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>

• Returns Promise<IndexDescriptionCompact | IndexDescriptionInfo[]>

• indexInformation(): Promise<IndexDescriptionCompact>

• Returns Promise<IndexDescriptionCompact>

initializeOrderedBulkOp

• initializeOrderedBulkOp(options?): OrderedBulkOperation

• Returns OrderedBulkOperation

initializeUnorderedBulkOp

• initializeUnorderedBulkOp(options?): UnorderedBulkOperation

• Returns UnorderedBulkOperation

insertMany

• insertMany(docs, options?): Promise<InsertManyResult<TSchema>>

• Returns Promise<InsertManyResult<TSchema>>

insertOne

• insertOne(doc, options?): Promise<InsertOneResult<TSchema>>

• Returns Promise<InsertOneResult<TSchema>>

isCapped

• isCapped(options?): Promise<boolean>

• Returns Promise<boolean>

listIndexes

• listIndexes(options?): ListIndexesCursor

• Returns ListIndexesCursor

listSearchIndexes

• listSearchIndexes(options?): ListSearchIndexesCursor

• Returns ListSearchIndexesCursor

• listSearchIndexes(name, options?): ListSearchIndexesCursor

• Returns ListSearchIndexesCursor

options

• options(options?): Promise<Document>

• Returns Promise<Document>

rename

• rename(newName, options?): Promise<Collection<Document>>

• Returns Promise<Collection<Document>>

replaceOne

• replaceOne(filter, replacement, options?): Promise<UpdateResult<TSchema>>

• Returns Promise<UpdateResult<TSchema>>

updateMany

• updateMany(filter, update, options?): Promise<UpdateResult<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • update: Document[] | UpdateFilter<TSchema>
  • Optionaloptions: UpdateOptions

Returns Promise<UpdateResult<TSchema>>

updateOne

• updateOne(filter, update, options?): Promise<UpdateResult<TSchema>>

• Parameters

  • filter: Filter<TSchema>
  • update: Document[] | UpdateFilter<TSchema>
  • Optionaloptions: UpdateOptions

Returns Promise<UpdateResult<TSchema>>

updateSearchIndex

• updateSearchIndex(name, definition): Promise<void>

• Parameters

  • name: string
  • definition: Document

Returns Promise<void>

watch

• watch<TLocal, TChange>(pipeline?, options?): ChangeStream<TLocal, TChange>

• Type Parameters

  • TLocal extends Document = TSchema
  • TChange extends Document = ChangeStreamDocument<TLocal>

Returns ChangeStream<TLocal, TChange>