Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
MongoDB.ReplaceOne
This replace one document in the collection that match selector with replacement.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
MongoDB | 12.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
Parameters
Parameter | Description | Example |
---|---|---|
MongoDBRef | The reference number for the mongo connection. | $MongoDB |
selectorJSON | A JSON containing the query to match the document for updating. | |
updateJSON | A JSON containing the replacement document. |
Result
Returns JSON or error.
Description
This replace one document in the collection that match selector with replacement.Returns the reply JSON is populated with the fields matchedCount, modifiedCount, upsertedCount, and optionally upsertedId if applicable. If there is a server error then reply contains either a writeErrors array with one subdocument or a writeConcernErrors array.
Examples
Replace one record:
Set Variable [ $Mongo ; Value: MBS( "MongoDB.New" ) ]
Set Variable [ $r ; Value: MBS( "MongoDB.SetURI"; $Mongo; "mongodb://localhost/" ) ]
Set Variable [ $r ; Value: MBS( "MongoDB.Connect"; $Mongo) ]
Set Variable [ $r ; Value: MBS( "MongoDB.OpenDatabase"; $Mongo; "local" ) ]
Set Variable [ $r ; Value: MBS( "MongoDB.OpenCollection"; $Mongo; "test" ) ]
# replace a record with a new JSON
Set Variable [ $r ; Value: MBS( "MongoDB.ReplaceOne"; $Mongo; "{\"Hello\": \"World\"}"; "{\"Hello\": \"World\", \"OtherField\": 123}") ]
Show Custom Dialog [ "Result" ; $r ]
Set Variable [ $r ; Value: MBS( "MongoDB.Release"; $Mongo ) ]
See also
- MongoDB.Connect
- MongoDB.DeleteOne
- MongoDB.New
- MongoDB.OpenCollection
- MongoDB.OpenDatabase
- MongoDB.Release
- MongoDB.SetURI
- MongoDB.UpdateOne
Example Databases
Blog Entries
This function checks for a license.
Created 22nd May 2022, last changed 13th June 2022