Deleting Entities

Search…

Deleting Entities

delete
You can delete an entity by calling the delete method on it.
1
var user = getInstance( "User" ).find( 1 );
2
user.delete();
Copied!
The entity will still exist in any variables you have stored it in, even though it has been deleted from the database.
deleteAll
Just like updateAll, you can delete many records from the database by specifying a query with constraints and then calling the deleteAll method.
Name
Type
Required
Default
Description
ids
array
false
[]
An optional array of ids to add to the previously configured query.  The ids will be added to a WHERE IN statement on the primary key columns.
Deletes matching entities according to the configured query.
1
getInstance( "User" )
2
    .whereActive( false )
3
    .deleteAll();
Copied!
Additionally, you can pass in an array of ids to deleteAll to delete only those ids.  Note that any previously configured constraints will still apply.
1
getInstance( "User" ).deleteAll( [ 4, 10, 22 ] );
Copied!

Updating Existing Entities

Query Scopes and Subselects

Last modified 2yr ago

Copy link

Edit on GitHub

Contents

delete

deleteAll