-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
setOnInsert.txt
73 lines (53 loc) · 1.87 KB
/
setOnInsert.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
============
$setOnInsert
============
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. update:: $setOnInsert
If an update operation with :ref:`upsert: true <upsert-parameter>`
results in an insert of a document, then :update:`$setOnInsert`
assigns the specified values to the fields in the document. If the
update operation does not result in an insert,
:update:`$setOnInsert` does nothing.
You can specify the ``upsert`` option for either the
:method:`db.collection.update()` or
:method:`db.collection.findAndModify()` methods.
.. code-block:: javascript
db.collection.update(
<query>,
{ $setOnInsert: { <field1>: <value1>, ... } },
{ upsert: true }
)
.. include:: /includes/use-dot-notation.rst
Example
--------
A collection named ``products`` contains no documents.
Then, the following :method:`db.collection.update()` with :ref:`upsert:
true <upsert-parameter>` inserts a new document.
.. code-block:: javascript
db.products.update(
{ _id: 1 },
{
$set: { item: "apple" },
$setOnInsert: { defaultQty: 100 }
},
{ upsert: true }
)
MongoDB creates a new document with ``_id`` equal to ``1`` from the
``<query>`` condition, and then applies the :update:`$set` and
:update:`$setOnInsert` operations to this document.
The ``products`` collection contains the newly-inserted document:
.. code-block:: javascript
{ "_id" : 1, "item" : "apple", "defaultQty" : 100 }
If the :method:`db.collection.update()` with :ref:`upsert: true
<upsert-parameter>` had found a matching document, then MongoDB
performs an update, applying the :update:`$set` operation but ignoring
the :update:`$setOnInsert` operation.
.. seealso:: :method:`db.collection.update()`,
:method:`db.collection.findAndModify()`