Skip to content

docs(NODE-4263): document initialize bulk op function require connection #3308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 29, 2022
Merged

docs(NODE-4263): document initialize bulk op function require connection #3308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4aa2bd
docs(NODE-4263): document initialize bulk op function require connection
nbbeeken Jun 29, 2022
be77873
docs: fixes
nbbeeken Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions src/collection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1544,12 +1544,26 @@ export class Collection<TSchema extends Document = Document> {
);
}

/** Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order. */
/**
* Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
*
* @throws MongoNotConnectedError
* @remarks
* **NOTE:** MongoClient must be connected prior to calling this method due to a known limitation in this legacy implemenation.
* However, `collection.bulkWrite()` provides an equivalent API that does not require prior connecting.
*/
initializeUnorderedBulkOp(options?: BulkWriteOptions): UnorderedBulkOperation {
return new UnorderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options));
}

/** Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types. */
/**
* Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.
*
* @throws MongoNotConnectedError
* @remarks
* **NOTE:** MongoClient must be connected prior to calling this method due to a known limitation in this legacy implemenation.
* However, `collection.bulkWrite()` provides an equivalent API that does not require prior connecting.
*/
initializeOrderedBulkOp(options?: BulkWriteOptions): OrderedBulkOperation {
return new OrderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options));
}
Expand Down