Updating Existing Entities

Search…
save
Updates are handled identically to inserts when using the save method. The only difference is that instead of starting with a new entity, we start with an existing entity.
1
var user = getInstance( "User" ).find( 1 );
2
user.setPassword( "newpassword" );
3
user.save();
Copied!
update
You can update multiple fields at once using the update method. This is similar to the create method for creating new entities.
Name
Type
Required
Default
Description
attributes
struct
false
{}
A struct of key / value pairs to update on the entity.
ignoreNonExistentAttributes
boolean
false
false
If true, does not throw an exception if an attribute does not exist.  Instead, it skips the non-existent attribute.
1
var user = getInstance( "User" ).find( 1 );
2
user.update( {
3
   email = "[email protected]",
4
   password = "newpassword"
5
} );
Copied!
There is no need to call save when using the update method.
By default, if you have a key in the struct that doesn't match a property in the entity the update method will fail. If you add the optional argument ignoreNonExistentAttributes set to true, those missing keys are ignored. Now you can pass the rc scope from your submitted form directly into the update method and not worry about any other keys in the rc like event that would cause the method to fail.
1
var user = getInstance( "User" ).find( 1 );
2
user.update( rc, true );
Copied!
updateOrCreate
Name
Type
Required
Default
Description
attributes
struct
false
{}
A struct of attributes to restrict the query. If no entity is found the attributes are filled on the new entity created.
newAttributes
struct
false
{}
A struct of attributes to update on the found entity or the new entity if no entity is found.
ignoreNonExistentAttributes
boolean
false
false
If true, does not throw an exception if an attribute does not exist.  Instead, it skips the non-existent attribute.
Updates an existing record or creates a new record with the given attributes.
1
var user = getInstance( "User" ).updateOrCreate( {
2
    "username": "newuser"
3
} );
Copied!
updateAll
Name
Type
Required
Default
Description
attributes
struct
false
{}
The attributes to update on the matching records.
force
boolean
false
false
If true, skips read-only entity and read-only attribute checks.
Updates matching entities with the given attributes according to the configured query. This is analagous to qb's update method.​
1
getInstance( "User" )
2
    .where( "lastLoggedIn", ">", dateAdd( "m", 3, now() ) )
3
    .updateAll( {
4
        "active" = 0
5
    } );
Copied!
fresh
Name
Type
Required
Default
Description
No arguments
​
``
​
​
Retrieves a new entity from the database with the same key value as the current entity. Useful for seeing any changes made to the record in the database. This function executes a query.
1
var user = getInstance( "User" ).findOrFail( rc.userID );
2
var sameUser = user.fresh();
Copied!
refresh
Name
Type
Required
Default
Description
No arguments
​
``
​
​
Refreshes the attributes data for the entity with data from the database. This differs from fresh in that it operates on the current entity instead of returning a new one. This function executes a query.
1
var user = getInstance( "User" ).findOrFail( rc.userID );
2
user.refresh(); // user now has updated data from the database
Copied!
Creating New Entities
Deleting Entities
Last modified 1yr ago
Copy link
Edit on GitHub
Contents