When you have created or retrieved an object, you can save it to the database by calling its save() method. This method returns
true if the object passes all validations and the object was saved to the database. Otherwise, it returns
This chapter will focus on how to update records. Read the Creating Records chapter for more information about how to create new records.
Let's start with an example of getting a blog post from the database, updating its title, and saving it back:
<cfset post = model("post").findByKey(33)> <cfset post.title = "New version of Wheels just released"> <cfset post.save()>
You can also change the values of one or more properties and save them to the database in one single call using the
update() method, like this:
<cfset post = model("post").findByKey(33)> <cfset post.update(title="New version of Wheels just released")>
You can also pass in name/value pairs to
update() as a struct. The main reason this method accepts a struct is to allow you to easily use it with forms.
This is how it would look if you wanted to update the properties for a post based on a submitted form.
<cfset post = model("post").findByKey(params.key)> <cfset post.update(params.post)>
It's also possible to combine named arguments with a struct, but then you need to name the struct argument as
<cfset post = model("post").findByKey(params.key)> <cfset post.update( title="New version of Wheels just released", properties=params.post ) >
Give the updateByKey() method a primary key value (or several if you use composite keys) in the
key argument, and it will update the corresponding record in your table with the properties you give it. You can pass in the properties either as named arguments or as a struct to the
This method returns the object with the primary key value you specified. If the object does not pass validation, it will be returned anyway, but nothing will be saved to the database.
By default, updateByKey() will fetch the object first and call the
update() method on it, thus invoking any callbacks and validations you have specified for the model. You can change this behavior by passing in
instantiate=false. Then it will just update the record from the table using a simple UPDATE query.
An example of using updateByKey() by passing a struct:
<cfset result = model("post").updateByKey(33, params.post)>
And an example of using updateByKey() by passing named arguments:
<cfset result = model("post").updateByKey( id=33, title="New version of Wheels just released", published=1 ) >
The updateAll() method allows you to update more than one record in a single call. You specify what records to update with the
where argument and tell Wheels what updates to make using named arguments for the properties.
where argument is used exactly as you specify it in the
WHERE clause of the query (with the exception that Wheels automatically wraps everything properly in
cfqueryparam tags). So make sure that you place those commas and quotes correctly!
<cfset recordsReturned = model("post").updateAll( published=1, publishedAt=Now(), where="published=0" ) >