diff --git a/README.md b/README.md index 246cfa7..cbecdef 100644 --- a/README.md +++ b/README.md @@ -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]: }` 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: @@ -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]: }` 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.