API.md in row_boat-0.3.0 vs API.md in row_boat-0.4.0
- old
+ new
@@ -46,10 +46,11 @@
It returns a hash containing
- `:invalid_records` - an array of all records that failed to import since they were invalid. If you've configured the `:validate` option to be `false` it will be an empty array.
- `:total_inserted` - the total number of records inserted into the database.
- `:inserted_ids` - an array of all of the ids of records inserted into the database.
+- `:skipped_rows` - every row skipped by returning `nil` from [`preprocess_row`](#preprocess_row).
If you want to pass additional information to help import CSVs, *don't override this method*. It just passes through to [`initialize`](#initialize) so override that :)
### Example
@@ -193,10 +194,10 @@
### Description
Implement this method if you need to do some work on the row before the record is inserted/updated.
-If you return `nil` from this method, the row will be skipped in the import.
+If you return `nil` from this method, the row will be skipped in the import. You can access these rows in the return value from [`.import`](#import) (the `:skipped_rows` key).
You also have access to `row_number` here.
If the work you intend to do with the row only requires changing one attribute, it is recommended that you override [`value_converters`](#value_converters) instead of this.