Skip to content

Commit

Permalink
Bump version and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
louischatriot committed Feb 3, 2016
1 parent 58edd6e commit 2e44b81
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.md
Expand Up @@ -432,7 +432,7 @@ db.count({}, function (err, count) {
* `query` is the same kind of finding query you use with `find` and `findOne`
* `update` specifies how the documents should be modified. It is either a new document or a set of modifiers (you cannot use both together, it doesn't make sense!)
* A new document will replace the matched docs
* The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a field's value and `$min`, `$max` to change field's value, only if provided value is less (greater equivalently for $max) than the current field's value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`. See examples below for the syntax.
* The modifiers create the fields they need to modify if they don't exist, and you can apply them to subdocs. Available field modifiers are `$set` to change a field's value, `$unset` to delete a field, `$inc` to increment a field's value and `$min`/`$max` to change field's value, only if provided value is less/greater than current value. To work on arrays, you have `$push`, `$pop`, `$addToSet`, `$pull`, and the special `$each` and `$slice`. See examples below for the syntax.
* `options` is an object with two possible parameters
* `multi` (defaults to `false`) which allows the modification of several documents if set to true
* `upsert` (defaults to `false`) if you want to insert a new document corresponding to the `update` rules if your `query` doesn't match anything. If your `update` is a simple object with no modifiers, it is the inserted document. In the other case, the `query` is stripped from all operator recursively, and the `update` is applied to it.
Expand Down Expand Up @@ -541,16 +541,15 @@ db.update({ _id: 'id6' }, { $push: { fruits: { $each: ['banana'], $slice: 2 } }
// Now the fruits array is ['apple', 'orange']
});

// Update the value of the field, only if specified field is smaller or greater than the current value of the field
// $min/$max to update only if provided value is less/greater than current value
// Let's say the database contains this document
// doc = { _id: 'id1', name: 'Name', value: 5 }
// $min can be used to update field if provided value is less than the current document value
// doc = { _id: 'id', name: 'Name', value: 5 }
db.update({ _id: 'id1' }, { $min: { value: 2 } }, {}, function () {
// The document will be updated to { _id: 'id1', name: 'Name', value: 2 }
// The document will be updated to { _id: 'id', name: 'Name', value: 2 }
});
// $max can be used to update field if provided value is greater than the current document value
db.update({ _id: 'id1' }, { $max: { value: 8 } }, {}, function () {
// The document will be updated to { _id: 'id1', name: 'Name', value: 8 }

db.update({ _id: 'id1' }, { $min: { value: 8 } }, {}, function () {
// The document will not be modified
});
```

Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "nedb",
"version": "1.7.3",
"version": "1.7.4",
"author": {
"name": "Louis Chatriot",
"email": "louis.chatriot@gmail.com"
Expand Down

0 comments on commit 2e44b81

Please sign in to comment.