README.md in scripterator-0.1.1 vs README.md in scripterator-1.0.0
- old
+ new
@@ -22,10 +22,11 @@
Works with ActiveRecord 3.* (Rails 4 support coming).
## Usage
Create a .rb file with your script code:
+
```ruby
Scripterator.run "Convert users from legacy auth data" do
before do
User.skip_some_callbacks_we_want_to_avoid_during_script_running
@@ -60,10 +61,14 @@
Total rows migrated: 34903 / 34903
0 rows previously migrated and skipped
0 errors
```
+Or, instead of a range, pass in the specific IDs you want to run against:
+
+ $ ID_LIST=1,2,100,999 bundle exec rails runner my_script.rb >out.txt
+
Retrieve set information about checked and failed records:
```
> Scripterator.failed_ids_for "Convert users from legacy auth data"
=> [14011, 15634, 17301, 17302]
@@ -86,9 +91,10 @@
Environment variable options:
- `START`: first model ID to scripterate
- `END`: last model ID to scripterate
+- `ID_LIST`: comma-delimited list of IDs to scripterate (e.g. "ID_LIST=1,99,440,23")
- `REDIS_EXPIRATION`: amount of time (in seconds) before Redis result sets (checked IDs and failed IDs) are expired
Either a starting or an ending ID must be provided.
## Configuration