delete_in_batches 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a63cc69d5539bdab7a0cbc60bf015049ca8ce729
+  data.tar.gz: 6f213288c1f9a52666af9d9cb01b5ec615ad02ee
+SHA512:
+  metadata.gz: b9a00e37f6272dff4674fcbbbaea290b8c047265a51718c07fce8bf2ca5584288341db59b377fe5be3132b3fd0aeef85a1ad05487f86a2f4fcd4071dc6db29d2
+  data.tar.gz: a02e0da81efae6cb1d4782a4401b83d9133bb3253e3d96e4f817e34834e4168ad4ac67f5eb54bfc28673433b25e01cbd91da406a20e3727d9258ecd502be0df0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in delete_in_batches.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# delete_in_batches
+
+:fire: The fastest way to delete millions of rows with ActiveRecord
+
+## Slow
+
+```ruby
+Tweet.where(user_id: 1).delete_all
+# DELETE FROM tweets WHERE user_id = 1
+```
+
+The database performs the delete in a transaction - either all the records are deleted (query completes) or none are, due to [multiversion concurrency control](http://en.wikipedia.org/wiki/Multiversion_concurrency_control).
+
+## Fast
+
+```ruby
+Tweet.where(user_id: 1).delete_in_batches
+# DELETE FROM tweets WHERE id IN (SELECT id FROM tweets WHERE user_id = 1 LIMIT 10000)
+# DELETE FROM tweets WHERE id IN (SELECT id FROM tweets WHERE user_id = 1 LIMIT 10000)
+# ...
+```
+
+**Important:** Be sure to test your query before running it in production
+
+Change the batch size
+
+```ruby
+Tweet.where(user_id: 1).delete_in_batches(batch_size: 50000) # defaults to 10000
+```
+
+Show progress
+
+```ruby
+Tweet.where(user_id: 1).delete_in_batches do
+  puts "Another batch deleted"
+end
+```
+
+Works with associations
+
+```ruby
+user.tweets.delete_in_batches
+```
+
+To delete all rows in a table, `TRUNCATE` is fastest.
+
+```ruby
+ActiveRecord::Base.connection.execute("TRUNCATE tweets")
+```
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "delete_in_batches"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/delete_in_batches/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/delete_in_batches/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/delete_in_batches.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delete_in_batches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "delete_in_batches"
+  spec.version       = DeleteInBatches::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{The fastest way to delete millions of rows with ActiveRecord}
+  spec.description   = %q{The fastest way to delete millions of rows with ActiveRecord}
+  spec.homepage      = "https://github.com/ankane/delete_in_batches"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/delete_in_batches.rb

@@ -0,0 +1,26 @@
+require "delete_in_batches/version"
+
+module DeleteInBatches
+
+  def delete_in_batches(options = {}, &block)
+    batch_size = options[:batch_size] || 10000
+
+    # TODO dry
+    sql =
+      if connection.respond_to?(:unprepared_statement)
+        # ActiveRecord 4
+        connection.unprepared_statement do
+          select(:id).limit(batch_size).to_sql
+        end
+      else
+        select(:id).limit(batch_size).to_sql
+      end
+
+    while connection.delete("DELETE FROM #{table_name} WHERE id IN (#{sql})") == batch_size
+      yield if block_given?
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :extend, DeleteInBatches

data/lib/delete_in_batches/version.rb

@@ -0,0 +1,3 @@
+module DeleteInBatches
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: delete_in_batches
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The fastest way to delete millions of rows with ActiveRecord
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delete_in_batches.gemspec
+- lib/delete_in_batches.rb
+- lib/delete_in_batches/version.rb
+homepage: https://github.com/ankane/delete_in_batches
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: The fastest way to delete millions of rows with ActiveRecord
+test_files: []