Interface CollectionUpdateFilter<Schema>

Add an element to an array field in the document if it does not already exist.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $addToSet: {
    'items': 'Extended warranty - 5 years'
  }
}
Copy

Set the value of a field to the current date.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $currentDate: {
    'purchase_date': true
  }
}
Copy

Increment the value of a field in the document if it's potentially a number.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $inc: {
    'customer.age': 1
  }
}
Copy

Only update the field if the specified value is greater than the existing value.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $max: {
    'customer.age': 65
  }
}
Copy

Only update the field if the specified value is less than the existing value.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $min: {
    'customer.age': 18
  }
}
Copy

Multiply the value of a field in the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $mul: {
    'customer.age': 1.1
  }
}
Copy

Remove an element from an array field in the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $pop: {
    'items': -1
  }
}
Copy

Add an element to an array field in the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $push: {
    'items': 'Extended warranty - 5 years'
  }
}
Copy

Rename a field in the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $rename: {
    'customer.name': 'client.name'
  }
}
Copy

Set the value of a field in the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $set: {
    'customer.name': 'Jim B.'
  }
}
Copy

Set the value of a field in the document if an upsert is performed.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $setOnInsert: {
    'customer.name': 'Jim B.'
  }
}
Copy

Remove the field from the document.

Example

const updateFilter: UpdateFilter<SomeDoc> = {
  $unset: {
    'customer.phone': ''
  }
}
Copy