`updateByKey()`

Description

Finds the object with the supplied key and saves it (if validation permits it) with the supplied properties and/or named arguments. Property names and values can be passed in either using named arguments or as a struct to the properties argument. Returns true if the object was found and updated successfully, false otherwise.

Function Syntax

updateByKey(key [, properties ])

Parameters

Parameter	Type	Required	Default	Description
`key`	`any`	Yes		Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list or a numeric value.
`properties`	`struct`	No	`[runtime expression]`	The properties you want to set on the object (can also be passed in as named arguments).

Examples

<!--- Updates the object with `33` as the primary key value with values passed in through the URL/form --->
<cfset result = model("post").updateByKey(33, params.post)>

<!--- Updates the object with `33` using named arguments --->
<cfset result = model("post").updateByKey(key=33, title="New version of Wheels just released", published=1)>