- Stitch >
- MongoDB Atlas >
- Reference >
- MongoDB Actions
collection.updateOne()¶
On this page
Definition¶
-
collection.
updateOne
()¶
Update a single document in a collection based on a query filter.
Usage¶
Example¶
- Functions
- JavaScript SDK
- Android SDK
- iOS SDK
To call the collection.updateOne()
action from a
Function, get a collection handle with
database.collection()
then call the handle’s
updateOne()
method.
To call the collection.updateOne()
action from a JavaScript
SDK, use the RemoteMongoCollection.updateOne() method.
To call the collection.updateOne()
action from the
Java/Android SDK, use the RemoteMongoCollection.updateOne() method.
To call the collection.updateOne()
action from the
Swift/iOS SDK, use the RemoteMongoCollection.updateOne() method.
Parameters¶
- Functions
- JavaScript SDK
- Android SDK
- iOS SDK
The collection.updateOne()
action has the following form:
Parameter | Description |
---|---|
Query Filter query: <document> |
Required. A standard MongoDB query document that specifies which document to update. You can use most query selectors except for evaluation, geospatial, or bitwise selectors. If multiple documents match the query, only the first document in sort order or natural order will be updated. |
Update Operation update: <document> |
Required. A standard MongoDB update document that specifies the update operation to perform on the document that matches the query. You can use most update operators. |
Update Options options: <document> |
A document that specifies configuration options for the query.
The |
Upsert options.upsert: <boolean> |
Optional. Default: false . A boolean that, if true ,
indicates that MongoDB should insert a new document that
matches the query filter when the query does not match any
existing documents in the collection. |
The updateOne() method has the following form:
Parameter | Description |
---|---|
Query Filter query: <document> |
Required. A standard MongoDB query document that specifies which document to update. You can use most query selectors except for evaluation, geospatial, or bitwise selectors. If multiple documents match the query, only the first document in sort order or natural order will be updated. |
Update Operation update: <document> |
Required. A standard MongoDB update document that specifies the update operation to perform on the document that matches the query. You can use most update operators. |
Update Options options: <document> |
A document that specifies configuration options for the query.
The |
Upsert options.upsert: <boolean> |
Optional. Default: false . A boolean that, if true ,
indicates that MongoDB should insert a new document that
matches the query filter when the query does not match any
existing documents in the collection. |
The updateOne() method has the following form:
Parameter | Description |
---|---|
Query Filter query: <document> |
Required. A standard MongoDB query document that specifies which document to update. You can use most query selectors except for evaluation, geospatial, or bitwise selectors. If multiple documents match the query, only the first document in sort order or natural order will be updated. |
Update Operation update: <document> |
Required. A standard MongoDB update document that specifies the update operation to perform on the document that matches the query. You can use most update operators. |
Update Options options: <document> |
A document that specifies configuration options for the query.
The |
Upsert options.upsert: <boolean> |
Optional. Default: false . A boolean that, if true ,
indicates that MongoDB should insert a new document that
matches the query filter when the query does not match any
existing documents in the collection. |
The updateOne() method has the following form:
Parameter | Description |
---|---|
Query Filter query: <document> |
Required. A standard MongoDB query document that specifies which document to update. You can use most query selectors except for evaluation, geospatial, or bitwise selectors. If multiple documents match the query, only the first document in sort order or natural order will be updated. |
Update Operation update: <document> |
Required. A standard MongoDB update document that specifies the update operation to perform on the document that matches the query. You can use most update operators. |
Update Options options: <document> |
A document that specifies configuration options for the query.
The |
Upsert options.upsert: <boolean> |
Optional. Default: false . A boolean that, if true ,
indicates that MongoDB should insert a new document that
matches the query filter when the query does not match any
existing documents in the collection. |
Return Value¶
- Functions
- JavaScript SDK
- Android SDK
- iOS SDK
The collection.updateOne()
action returns a Promise that
resolves to a document that describes the update operation.
The RemoteMongoCollection.updateOne() method returns a Promise that resolves to a RemoteUpdateResult object that describes the update operation.
The RemoteMongoCollection.updateOne() method returns a Task that resolves to a RemoteUpdateResult object that describes the update operation.
The RemoteMongoCollection.updateOne() method returns a StitchResult enum that resolves to a RemoteUpdateResult object that describes the update operation.
Value | Description |
---|---|
Matched Count result.matchedCount: <integer> result.matchedCount: <integer> result.matchedCount: <Long> result.matchedCount: <Int> |
The number of documents in the collection that match the provided query filter. |
Modified Count result.modifiedCount: <integer> result.modifiedCount: <integer> result.modifiedCount: <Long> result.modifiedCount: <Int> |
The number of documents in the collection that were modified by the update operation. |
Upserted ID result.upsertedId: <ObjectID> result.upsertedId: <ObjectID> result.upsertedId: <ObjectID> result.upsertedId: <ObjectID> |
The _id value of the document inserted by an upsert
operation. This value is only present when the upsert option
is enabled and the update query does not match any documents. |