Bulk Operations

InsertOneModel

To define an insert operation for a bulk write, create an InsertOneModel specifying the document you want to insert. To insert multiple documents, create an InsertOneModel for each document you want to insert.

You can specify the behavior of the InsertOneModel by using the following method:

The following example creates two InsertOneModel instances to insert two documents into the books collection:

models := []mongo.WriteModel{
	mongo.NewInsertOneModel().SetDocument(Book{Title: "Beloved", Author: "Toni Morrison", Length: 324}),
	mongo.NewInsertOneModel().SetDocument(Book{Title: "Outline", Author: "Rachel Cusk", Length: 258}),
}

ReplaceOneModel

To define a replace operation for a bulk write, create a ReplaceOneModel specifying the document you want replace and a replacement document. To replace multiple documents, create a ReplaceOneModel for each document you want to replace.

You can specify the behavior of the ReplaceOneModel by using the following methods:

The following example creates a ReplaceOneModel to replace a document in the books collection in which the title value is "Lucy":

models := []mongo.WriteModel{
	mongo.NewReplaceOneModel().SetFilter(bson.D{{"title", "Lucy"}}).
		SetReplacement(Book{Title: "On Beauty", Author: "Zadie Smith", Length: 473}),
}

UpdateOneModel and UpdateManyModel

To define an update operation for a bulk write, create an UpdateOneModel specifying the document you want to update and an update document. To update multiple documents, use an UpdateManyModel.

You can specify the behavior of each of the update models by using the following methods:

The following example creates an UpdateOneModel to update a document in the books collection, decrementing a document's length by 15 if the author is "Elena Ferrante":

models := []mongo.WriteModel{
	mongo.NewUpdateOneModel().SetFilter(bson.D{{"author", "Elena Ferrante"}}).
		SetUpdate(bson.D{{"$inc", bson.D{{"length", -15}}}}),
}

DeleteOneModel and DeleteManyModel

To define a delete operation for a bulk write, create a DeleteOneModel specifying the document you want to delete. To delete multiple documents, use the DeleteManyModel.

You can specify the behavior of each of the delete models by using the following methods:

The following example creates a DeleteManyModel to delete documents in the books collection in which the length is greater than 300:

models := []mongo.WriteModel{
	mongo.NewDeleteManyModel().SetFilter(bson.D{{"length", bson.D{{"$gt", 300}}}}),
}

Ordered

By default, the BulkWrite() method runs bulk operations in order you added them and stops if an error occurs.

opts := options.BulkWrite().SetOrdered(true)

Unordered

To run bulk write operations in any order and continue if an error occurs, pass a value of false to the SetOrdered() method. The method reports errors after the operation completes.

The following example performs the following actions in any order:

• Inserts two documents

• Replaces a document where the title is "My Brilliant Friend" with a new document

• Increments every document's length by 10 if the current length value is less than 200

• Deletes all documents where the author field value includes "Jam"

models := []mongo.WriteModel{
	mongo.NewInsertOneModel().SetDocument(Book{Title: "Middlemarch", Author: "George Eliot", Length: 904}),
	mongo.NewInsertOneModel().SetDocument(Book{Title: "Pale Fire", Author: "Vladimir Nabokov", Length: 246}),
	mongo.NewReplaceOneModel().SetFilter(bson.D{{"title", "My Brilliant Friend"}}).
		SetReplacement(Book{Title: "Atonement", Author: "Ian McEwan", Length: 351}),
	mongo.NewUpdateManyModel().SetFilter(bson.D{{"length", bson.D{{"$lt", 200}}}}).
		SetUpdate(bson.D{{"$inc", bson.D{{"length", 10}}}}),
	mongo.NewDeleteManyModel().SetFilter(bson.D{{"author", bson.D{{"$regex", "Jam"}}}}),
}
// Specifies that the bulk write is unordered
opts := options.BulkWrite().SetOrdered(false)
// Runs the bulk write operation and prints a summary of the
// data changes
results, err := bookColl.BulkWrite(context.TODO(), models, opts)
if err != nil {
	panic(err)
}
fmt.Printf("Number of documents inserted: %d\n", results.InsertedCount)
fmt.Printf("Number of documents replaced or updated: %d\n", results.ModifiedCount)
fmt.Printf("Number of documents deleted: %d\n", results.DeletedCount)

Number of documents inserted: 2
Number of documents replaced or updated: 2
Number of documents deleted: 1

The following documents are present in the books collection after the bulk operation:

{"title":"Atonement","author":"Ian McEwan","length":351}
{"title":"Middlemarch","author":"George Eliot","length":904}
{"title":"Pale Fire","author":"Vladimir Nabokov","length":246}

ClientInsertOneModel

To define an insert operation for a bulk write, create a ClientInsertOneModel specifying the document you want to insert. To insert multiple documents, create a ClientInsertOneModel for each document you want to insert.

You can specify the behavior of the ClientInsertOneModel by using the following method:

The following example creates two ClientInsertOneModel instances to insert one document into the books collection and one document into the poems collection:

bookInsertDoc := Book{Title: "Parable of the Sower", Author: "Octavia E. Butler", Length: 320}
poemInsertDoc := Poem{Title: "Fame is a fickle food", Author: "Emily Dickinson", Year: 1659}
writes := []mongo.ClientBulkWrite{
	{"db", "books", mongo.NewClientInsertOneModel().SetDocument(bookInsertDoc)},
	{"db", "poems", mongo.NewClientInsertOneModel().SetDocument(poemInsertDoc)},
}

ClientReplaceOneModel

To define a replace operation for a bulk write, create a ClientReplaceOneModel specifying the document you want to replace and a replacement document. To replace multiple documents, create a ClientReplaceOneModel for each document you want to replace.

You can specify the behavior of the ClientReplaceOneModel by using the following methods:

This example creates ClientReplaceOneModel instances to define the following operations:

• Replace operation on the books collection to replace a document in which the title value is "Lucy"

• Replace operation on the poems collection to replace a document in which the title value is "Song of Myself"

writes := []mongo.ClientBulkWrite{
	{"db", "books", mongo.NewClientReplaceOneModel().
		SetFilter(bson.D{{"title", "Lucy"}}).
		SetReplacement(Book{Title: "On Beauty", Author: "Zadie Smith", Length: 473})},
	{"db", "poems", mongo.NewClientReplaceOneModel().
		SetFilter(bson.D{{"title", "Song of Myself"}}).
		SetReplacement(Poem{Title: "America", Author: "Walt Whitman", Year: 1888})},
}

ClientUpdateOneModel and ClientUpdateManyModel

To define an update operation for a bulk write, create a ClientUpdateOneModel specifying the document you want to update and an update document. To update multiple documents, use a ClientUpdateManyModel.

You can specify the behavior of each of the update models by using the following methods:

This example creates ClientUpdateOneModel instances to define the following operations:

• Update operation on the books collection to update a document in which the author value is "Elena Ferrante"

• Update operation on the poems collection to update a document in which the author value is "Ada Limon"

writes := []mongo.ClientBulkWrite{
	{"db", "books", mongo.NewClientUpdateOneModel().
		SetFilter(bson.D{{"author", "Elena Ferrante"}}).
		SetUpdate(bson.D{{"$inc", bson.D{{"length", -15}}}})},
	{"db", "poems", mongo.NewClientUpdateOneModel().
		SetFilter(bson.D{{"author", "Ada Limon"}}).
		SetUpdate(bson.D{{"author", "Ada Limón"}})},
}

ClientDeleteOneModel and ClientDeleteManyModel

To define a delete operation for a bulk write, create a ClientDeleteOneModel specifying the document you want to delete. To delete multiple documents, use the ClientDeleteManyModel.

You can specify the behavior of each of the delete models by using the following methods:

This example creates ClientDeleteOneModel instances to define the following operations:

• Delete operation on the books collection to delete a document in which the length value is 103

• Delete operation on the poems collection to delete a document in which the year value is 1855

writes := []mongo.ClientBulkWrite{
	{"db", "books", mongo.NewClientDeleteOneModel().
		SetFilter(bson.D{{"length", 103}})},
	{"db", "poems", mongo.NewClientDeleteOneModel().
		SetFilter(bson.D{{"year", 1855}})},
}

Ordered

By default, the BulkWrite() method executes bulk operations in order you added them and stops if an error occurs.

opts := options.ClientBulkWrite().SetOrdered(true)

Unordered

To run bulk write operations in any order and continue if an error occurs, pass a value of false to the SetOrdered() method. The method reports errors after the operation completes.

The following example performs the following actions in any order:

• Inserts a new document into the books and poems collections

• Updates a document in the poems collection that has a title value of "The Raincoat"

• Replaces a document in the books collection that has a title value of "My Brilliant Friend"

writes := []mongo.ClientBulkWrite{
	{"db", "books", mongo.NewClientInsertOneModel().
		SetDocument(Book{Title: "Middlemarch", Author: "George Eliot", Length: 904})},
	{"db", "poems", mongo.NewClientInsertOneModel().
		SetDocument(Poem{Title: "Mad Girl's Love Song", Author: "Sylvia Plath", Year: 1953})},
	{"db", "poems", mongo.NewClientUpdateOneModel().
		SetFilter(bson.D{{"title", "The Raincoat"}}).
		SetUpdate(bson.D{{"title", "The Conditional"}})},
	{"db", "books", mongo.NewClientReplaceOneModel().
		SetFilter(bson.D{{"title", "My Brilliant Friend"}}).
		SetReplacement(Book{Title: "The Story of a New Name", Author: "Elena Ferrante", Length: 480})},
}
opts := options.ClientBulkWrite().SetOrdered(false)
results, err := client.BulkWrite(context.TODO(), writes, opts)
if err != nil {
	panic(err)
}
fmt.Printf("Number of documents inserted: %d\n", results.InsertedCount)
fmt.Printf("Number of documents replaced or updated: %d\n", results.ModifiedCount)

Number of documents inserted: 2
Number of documents replaced or updated: 2