diff options
| -rw-r--r-- | activerecord/CHANGELOG | 2 | ||||
| -rwxr-xr-x | activerecord/lib/active_record/base.rb | 20 |
2 files changed, 20 insertions, 2 deletions
diff --git a/activerecord/CHANGELOG b/activerecord/CHANGELOG index ded7b57705..06e19641c7 100644 --- a/activerecord/CHANGELOG +++ b/activerecord/CHANGELOG @@ -1,5 +1,7 @@ *SVN* +* Document options and add examples for delete. Closes #7986 [fearoffish] + * Document options and add examples for destroy. Closes #7988 [fearoffish] * Document options and add examples for update_all. Closes #7990 [fearoffish] diff --git a/activerecord/lib/active_record/base.rb b/activerecord/lib/active_record/base.rb index 7e2d93202f..19077920ff 100755 --- a/activerecord/lib/active_record/base.rb +++ b/activerecord/lib/active_record/base.rb @@ -509,8 +509,24 @@ module ActiveRecord #:nodoc: end end - # Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them - # are deleted. + # Delete an object (or multiple objects) where the +id+ given matches the primary_key. A SQL +DELETE+ command + # is executed on the database which means that no callbacks are fired off running this. This is an efficient method + # of deleting records that don't need cleaning up after or other actions to be taken. + # + # Objects are _not_ instantiated with this method. + # + # ==== Options + # + # +id+ Can be either an Integer or an Array of Integers + # + # ==== Examples + # + # # Delete a single object + # Todo.delete(1) + # + # # Delete multiple objects + # todos = [1,2,3] + # Todo.delete(todos) def delete(id) delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ]) end |