apoc.atomic.add

Procedure

apoc.atomic.add(container Any, propertyName String, number Number, times Integer) - sets the given property to the sum of itself and the number value. The procedure then sets the property to the returned sum.

Signature

apoc.atomic.add(container :: ANY?, propertyName :: STRING?, number :: NUMBER?, times = 5 :: INTEGER?) :: (container :: ANY?, property :: STRING?, oldValue :: ANY?, newValue :: ANY?)

Input parameters

Name	Type	Default
container	ANY?	null
propertyName	STRING?	null
number	NUMBER?	null
times	INTEGER?	5

Name

Type

Default

container

ANY?

null

propertyName

STRING?

null

number

NUMBER?

null

times

INTEGER?

Output parameters

Name	Type
container	ANY?
property	STRING?
oldValue	ANY?
newValue	ANY?

Name

Type

container

ANY?

property

STRING?

oldValue

ANY?

newValue

ANY?

Usage examples

The examples in this section are based on the following sample graph:

CREATE (:Person {name:'Tom',age: 40})
CREATE (:Person {name:'Will',age: 35})
CREATE (:Person {name:'David', children: ['Anne','Sam','Paul']})
CREATE (:Person {name:'John', cars: ['Class A','X3','Focus']})
CREATE (:Person {name:'Ryan', salary1:1800, salary2:1500});

The following adds 10 to the property age for Tom:

MATCH (n:Person {name:'Tom'})
CALL apoc.atomic.add(n,'age',10,5)
YIELD oldValue, newValue
RETURN oldValue, newValue;

Table 1. Results
oldValue	newValue
40	50