Skip to content

Commit 800070f

Browse files
committed
Bump version to 0.11.0, update event log docs
on_event callback now receives domain events (event.event_type, event.dataset) instead of raw (event_type, payload) strings/dicts
1 parent 1de0c6a commit 800070f

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -259,10 +259,9 @@ That's it. The `event_log` and `reader_state` tables are created automatically i
259259
# run_consumer.py
260260
from ingestify.infra.event_log import EventLogConsumer
261261
262-
def on_event(event_type: str, payload: dict) -> None:
263-
if event_type == "revision_added":
264-
dataset_id = payload["dataset_id"]
265-
# trigger your downstream logic here
262+
def on_event(event) -> None:
263+
if event.event_type == "revision_added":
264+
trigger_downstream(event.dataset.dataset_id)
266265
267266
# Run once (e.g. from a cron job):
268267
EventLogConsumer.from_config("config.yaml", reader_name="my-service").run(on_event)
@@ -271,6 +270,8 @@ EventLogConsumer.from_config("config.yaml", reader_name="my-service").run(on_eve
271270
EventLogConsumer.from_config("config.yaml", reader_name="my-service").run(on_event, poll_interval=5)
272271
```
273272

273+
`on_event` receives a domain event with `event.event_type` and `event.dataset`. Available event types: `dataset_created`, `revision_added`, `metadata_updated`.
274+
274275
`from_config` reads `metadata_url` from your existing `config.yaml` — no duplicate connection strings.
275276

276277
`run()` returns `0` on success and `1` if a processing error occurred. On error the cursor is **not** advanced, so the failing event will be retried on the next run.

docs/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,9 @@ Write a small script (run as a cron job or long-running process) that reads from
189189
```python
190190
from ingestify.infra.event_log import EventLogConsumer
191191
192-
def on_event(event_type: str, payload: dict) -> None:
193-
if event_type == "revision_added":
194-
trigger_downstream(payload["dataset_id"])
192+
def on_event(event) -> None:
193+
if event.event_type == "revision_added":
194+
trigger_downstream(event.dataset.dataset_id)
195195
196196
# Run once (cron-friendly, exits 0 on success or 1 on error):
197197
EventLogConsumer.from_config("config.yaml", reader_name="my-service").run(on_event)

ingestify/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
from .source_base import Source, DatasetResource
1010
from .main import debug_source
1111

12-
__version__ = "0.10.0"
12+
__version__ = "0.11.0"

0 commit comments

Comments
 (0)