Bulk Writes

The bulk write API sends several write operations to the server in a single command. Use the bulk write API to reduce the number of network round-trips when performing several writes at a time. For example, to efficiently perform multiple updates, one might do:

collection = client['colors']
collection.bulk_write([
  {
    update_one: {
      filter: {name: 'yellow'},
      update: {'$set' => {hex: 'ffff00'}},
    },
  },
  {
    update_one: {
      filter: {name: 'purple'},
      update: {'$set' => {hex: '800080'}},
    },
  },
], ordered: true, write_concern: {w: :majority})

The following example shows how to execute different types of operations in the same request:

collection.bulk_write([
  { insert_one: { x: 1 } },
  { update_one: {
    filter: { x: 1 },
    update: {'$set' => { x: 2 } },
  } },
  { replace_one: {
    filter: { x: 2 },
    replacement: { x: 3 },
  } },
], :ordered => true)

The first argument to bulk_write is the list of operations to perform. Each operation must be specified as a hash with exactly one key which is the operation name and the operation specification as the corresponding value. The supported operations are detailed below. The bulk_write method also accepts the following options:

Valid bulk write operations are the following:

{ insert_one: { x: 1 } }

{ update_one: {
  filter: { x: 1 },
  update: { '$set' => { x: 2 } },
  # upsert is optional and defaults to false
  upsert: true,
} }

{ update_many: {
  filter: { x: 1 },
  update: { '$set' =>  { x: 2 } },
  # upsert is optional and defaults to false
  :upsert => true,
} }

{ replace_one: {
  filter: { x: 1 },
  replacement: { x: 2 },
  # upsert is optional and defaults to false
  upsert: true,
} }

{ delete_one: {
  filter: { x: 1 },
} }

{ delete_many: {
  filter: { x: 1 },
} }