Deleting records

To delete a single model instance, you can use the Model.delete_instance() shortcut. delete_instance() will delete the given model instance and can optionally delete any dependent objects recursively (by specifying recursive=True).

  1. >>> user = User.get(User.id == 1)
  2. >>> user.delete_instance()  # Returns the number of rows deleted.
  3. 1
  5. >>> User.get(User.id == 1)
  6. UserDoesNotExist: instance matching query does not exist:
  7. SQL: SELECT t1."id", t1."username" FROM "user" AS t1 WHERE t1."id" = ?
  8. PARAMS: [1]

To delete an arbitrary set of rows, you can issue a DELETE query. The following will delete all Tweet objects that are over one year old:

  1. >>> query = Tweet.delete().where(Tweet.creation_date < one_year_ago)
  2. >>> query.execute()  # Returns the number of rows deleted.
  3. 7

For more information, see the documentation on: