A extension that hooks into database events and sends JSON-formatted notifications to external programs.
Maintainer(s):
rustyconover
Compatibility Matrix
This table covers all DuckDB releases that have not reached end-of-life, including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.
| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
|---|---|---|---|---|---|
| Linux AMD64 | |||||
| Linux ARM64 | |||||
| macOS AMD64 | |||||
| macOS ARM64 | |||||
| Windows AMD64 | |||||
| Windows ARM64 | |||||
| WebAssembly |
Installing and Loading
INSTALL events FROM community;
LOAD events;
About events
For more information regarding usage, see the documentation.
Added Functions
This extension does not add any functions.
Overloaded Functions
This extension does not add any function overloads.
Added Types
This extension does not add any types.
Added Settings
| name | description | input_type | scope | aliases |
|---|---|---|---|---|
| events_async | If true, events are delivered asynchronously (fire and forget). Default is false (synchronous). | BOOLEAN | GLOBAL | [] |
| events_destination | Path to the program that receives event notifications via stdin | VARCHAR | GLOBAL | [] |
| events_session_name | Optional name for this session, included in all events | VARCHAR | GLOBAL | [] |
| events_types | List of event types to send to the destination. Valid types: connection_opened, connection_closed, query_begin, query_end, transaction_begin, transaction_commit, transaction_rollback, planning_error, finalize_prepare, execute_prepared, rebind_prepared_statement | VARCHAR[] | GLOBAL | [] |