Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tycooon authored Aug 19, 2019
1 parent b40cb64 commit 6b0116a
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,6 @@ This dataset extension provides the `#in_batches` method. The method splits data

Note: currently only PostgreSQL database is supported.

You can set the following options:

### pk
Overrides primary key of your dataset. This option is required in case your table doesn't have a real PK, otherwise you will get `Sequel::Extensions::Batches::MissingPKError`.

Note that you have to provide columns that don't contain NULL values, otherwise this may not work as intended. You will receive `Sequel::Extensions::Batches::NullPKError` in case batch processing detects a NULL value on it's way, but it's not guaranteed since it doesn't check all the rows for performance reasons.

### of
Sets chunk size (1000 by default).

### start
A hash `{ [column]: <start_value> }` that represents frame start for batch processing. Note that you will get `Sequel::Extensions::Batches::InvalidPKError` in case you provide a hash with wrong keys (ordering matters as well).

### finish
Same as `start` but represents the frame end.

## Installation

Add this line to your application's Gemfile:
Expand Down Expand Up @@ -67,6 +51,24 @@ Event.where(type: "login").in_batches(options) do |ds|
end
```

## Options

You can set the following options:

### pk
Overrides primary key of your dataset. This option is required in case your table doesn't have a real PK, otherwise you will get `Sequel::Extensions::Batches::MissingPKError`.

Note that you have to provide columns that don't contain NULL values, otherwise this may not work as intended. You will receive `Sequel::Extensions::Batches::NullPKError` in case batch processing detects a NULL value on it's way, but it's not guaranteed since it doesn't check all the rows for performance reasons.

### of
Sets chunk size (1000 by default).

### start
A hash `{ [column]: <start_value> }` that represents frame start for batch processing. Note that you will get `Sequel::Extensions::Batches::InvalidPKError` in case you provide a hash with wrong keys (ordering matters as well).

### finish
Same as `start` but represents the frame end.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/sequel-batches.
Expand Down

0 comments on commit 6b0116a

Please sign in to comment.