Skip to main content

remove_props

remove_props is a list of property keys that will be removed as part of an Update* command.

The properties in the remove_props will be permanently removed from the object. Names are matched without case sensitivity. Removing an absent property or repeating its name has no additional effect. If the same key also appears in properties, its replacement value is stored after removal. Property values, schema counts, and all affected indexes are updated in the same transaction; a failed transaction rolls those changes back together.

Example​

Remove the “SSN” property from entities of the type “Person” with the name “Jane Doe”

[{
"UpdateEntity": {
"with_class": "Person",
"constraints": ["$name", "==", "Jane-Doe"],
"remove_props": ["SSN"]
}
}]

Remove the “url” property from images of with a property “year_captured” less than 2000:

[{
"UpdateImage": {
"constraints": ["$year_captured", "<=", 2000],
"remove_props": ["url"]
}
}]