<mongoCollection variable>.ModifyOne (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Managing databases

Big Data

Managing Mongo files

Prefix syntax

ModifyOne

Presentation

Example

See also

<mongoCollection variable>.ModifyOne (Function)

In french: <Variable mongoCollection>.ModifieUn

Modifies a document in a collection of MongoDB database.

Example

Collection is mongoCollection
let sFilter = "{ ""name"": ""Andy"" }"
let sModification = "{ ""$inc"": { ""score"": 1 } }"
let d = Collection.ModifyOne(sFilter, sModification)

gclCollection is mongoCollection

// Find the first contact whose "FirstName" member is set to "Jack" and modify it to "Joey"
// Search filter
sFilter is string = "{ ""FirstName"": ""Jack"" }"
// Modification criterion
sModification is string = "{ ""$set"": {""FirstName"": ""Joey"" } }"
gclCollection.ModifyOne(sFilter, sModification)

Syntax

<Result> = <Collection>.ModifyOne(<Filter> , <Modification> [, <Sort>] [, <Option>])

<Result>: Variant

Document before or after modification (according to the selected option).

<Collection>: mongoCollection variable

Name of the mongoCollection variable that represents the MongoDB collection in which the modification will be made.

<Filter>: Type corresponding to the filter used

Description of filters in MongoDB format that will be applied to select the document to modify. This filter corresponds to:
a document in JSON format, in character string format.
a document in BSON format, in buffer format.
a variant.

<Modification>: Type corresponding to the format used

Description of modifications that will be made in the document corresponding to the filter. Corresponds to:
a document in JSON format, in character string format.
a document in BSON format, in buffer format.
a variant.

<Sort>: Optional type corresponding to the format used

Sort options used to define the first document that will be modified when several documents correspond to the filter. Corresponds to:
a document in JSON format, in character string format.
a document in BSON format, in buffer format.
a variant.

<Option>: Optional Integer constant

Modification options:
mongoAddIfNotFound Used to add the document if it does not exist in the collection.
mongoReturnValueAfter Used to return the document after modification.
By default, if this constant is not used, the document returned corresponds to the document before modification.

Component: wd280big.dll