delete_in_batches 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f67278c3ef5c894ad549056a5f5b877e69742eb830b69aa1e468da9b109705f
-  data.tar.gz: 4aee16921a6b72a72b392a46bd03f69c6de5b939ffa9c1fd1f17f9f0d3933da6
+  metadata.gz: 3a9e277e2aab5a09816e7df3578eb2a585d44e2fd1fe28a81c9f7606e9e6a6b9
+  data.tar.gz: 6df5995b465ef126c9f745d1a1553a7c90f24e65f04263fe673bde2c6593286e
 SHA512:
-  metadata.gz: 386a6ed82ebdc123f9f286abeb4d0f15645a3d82ee013c48058ba9b230cfb1b05d4ccca2306bc0b06e3568c9e9cb5a22bd2f26c1cfb978ff083997111703e315
-  data.tar.gz: 2d17af5375794e73ed3e2c8a41a3b5b8fc96f2e8807905194970fc79b63e500df5799618d3daf8bf560cba619534be8d71fd131813deb43fe043e3c56d924259
+  metadata.gz: c2cc30e03280311704551c681d57dac4badf6bb483834396bf8d7e4a0034cef9d5d910aab93c449936f1be6332ff49addba4f39d56c2fb769cd53f9f60691051
+  data.tar.gz: '08085780689fef205afe684d4d82a2deccb7325bac761bf47e0d7164e57d7a7965195469ea1b3396832bacd981284e290bbe58320107edd8f88ceb0099b0c109'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.1 (2021-03-06)
+
+- Added warning for non-Postgres databases
+- Added `sleep` option
+
 ## 0.2.0 (2020-05-27)
 
 - Improved Active Record integration

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2020 Andrew Kane
+Copyright (c) 2014-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,8 +1,8 @@
 # delete_in_batches
 
-:fire: The fastest way to delete 100k+ rows with ActiveRecord
+:fire: Fast batch deletes for Active Record and Postgres
 
-[![Build Status](https://travis-ci.org/ankane/delete_in_batches.svg?branch=master)](https://travis-ci.org/ankane/delete_in_batches)
+[![Build Status](https://github.com/ankane/delete_in_batches/workflows/build/badge.svg?branch=master)](https://github.com/ankane/delete_in_batches/actions)
 
 ## Installation
 
@@ -12,31 +12,12 @@ Add this line to your application’s Gemfile:
 gem 'delete_in_batches'
 ```
 
-## Slow
+## How to Use
 
-```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).
-
-## Faster
-
-```ruby
-Tweet.where(user_id: 1).in_batches(of: 10000).delete_all
-# SELECT tweets.id FROM tweets WHERE user_id = 1 ORDER BY id LIMIT 1000
-# DELETE FROM tweets WHERE user_id = 1 AND id IN (1, 2, 3, ...)
-# ...
-```
-
-## Fastest
+Delete rows in batches
 
 ```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
@@ -47,6 +28,12 @@ Change the batch size
 Tweet.where(user_id: 1).delete_in_batches(batch_size: 50000) # defaults to 10000
 ```
 
+Sleep between batches
+
+```ruby
+Tweet.where(user_id: 1).delete_in_batches(sleep: 0.01)
+```
+
 Show progress
 
 ```ruby
@@ -67,6 +54,12 @@ To delete all rows in a table, `TRUNCATE` is fastest.
 ActiveRecord::Base.connection.execute("TRUNCATE tweets")
 ```
 
+## History
+
+View the [changelog](https://github.com/ankane/delete_in_batches/blob/master/CHANGELOG.md)
+
+**Note:** This project originally had the description “the fastest way to delete 100k+ rows with ActiveRecord” but a single `DELETE` statement will likely be faster. See [this discussion](https://github.com/ankane/delete_in_batches/issues/4) for more details.
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -75,3 +68,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/delete_in_batches/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/delete_in_batches.git
+cd delete_in_batches
+bundle install
+bundle exec rake test
+```

data/lib/delete_in_batches.rb

@@ -5,6 +5,7 @@ require "active_support"
 require "delete_in_batches/version"
 
 module DeleteInBatches
+  # TODO use keyword arguments
   def delete_in_batches(options = {})
     batch_size = options[:batch_size] || 10000
 
@@ -16,8 +17,14 @@ module DeleteInBatches
       sql = "SELECT * FROM (#{sql}) AS t"
     end
 
+    unless connection.adapter_name =~ /postg/i
+      # TODO raise error
+      warn "[delete_in_batches] Use in_batches(of: #{batch_size.to_i}).delete_all instead of this gem for non-Postgres databases"
+    end
+
     while connection.delete("DELETE FROM #{quoted_table_name} WHERE #{pk} IN (#{sql})") == batch_size
       yield if block_given?
+      sleep(options[:sleep]) if options[:sleep]
     end
   end
 end

data/lib/delete_in_batches/version.rb

@@ -1,3 +1,3 @@
 module DeleteInBatches
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delete_in_batches
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,64 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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'
-- !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'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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: 
-email: andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,7 +39,7 @@ homepage: https://github.com/ankane/delete_in_batches
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: The fastest way to delete 100k+ rows with ActiveRecord
+summary: Fast batch deletes for Active Record and Postgres
 test_files: []