Skip to content

Commit

Permalink
Doc: Add information about accessing state during events
Browse files Browse the repository at this point in the history
  • Loading branch information
bpolaszek authored Nov 9, 2023
1 parent 142f306 commit bc68466
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,10 @@ The `EtlExecutor` emits various events during the workflow:
- `FlushExceptionEvent` when something wrong occured during flush (the exception can be dismissed)
- `EndEvent` whenever the workflow is complete.

All events give you access to the `EtlState` object, the state of the running ETL process, which allows you to read what's going on
(total number of items, number of loaded items, current extracted item index), write any arbitrary data into the `$state->context` array,
[skip items](#skipping-items), [stop the workflow](#stopping-the-workflow), and [trigger an early flush](#flush-frequency-and-early-flushes).

You can hook to those events during `EtlExecutor` instantiation, i.e.:

```php
Expand Down

0 comments on commit bc68466

Please sign in to comment.