https://github.com/query-farm/radio
Radio is a DuckDB extension by Query.Farm that brings real-time event streams into your SQL workflows. It enables DuckDB to receive and send events over systems like WebSocket and Redis Pub/Sub.
https://github.com/query-farm/radio
duckdb duckdb-extension event-processing events redis redis-pubsub streaming websocket websocket-client websockets
Last synced: 5 months ago
JSON representation
Radio is a DuckDB extension by Query.Farm that brings real-time event streams into your SQL workflows. It enables DuckDB to receive and send events over systems like WebSocket and Redis Pub/Sub.
- Host: GitHub
- URL: https://github.com/query-farm/radio
- Owner: Query-farm
- License: mit
- Created: 2025-05-19T00:25:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-06-12T22:08:40.000Z (8 months ago)
- Last Synced: 2025-06-12T23:23:57.553Z (8 months ago)
- Topics: duckdb, duckdb-extension, event-processing, events, redis, redis-pubsub, streaming, websocket, websocket-client, websockets
- Language: C++
- Homepage: https://query.farm/duckdb_extension_radio.html
- Size: 254 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# DuckDB Radio Extension
The **Radio** extension by **Query.Farm** enables DuckDB to interact seamlessly with real-time event systems such as WebSocket servers, message queues, and event buses. It allows DuckDB to both **receive** and **send** events: incoming messages are buffered and queryable with standard SQL, while outgoing events are also buffered and support delivery tracking.
The extension is named *Radio* because it effectively equips DuckDB with a two-way radio—allowing it to **listen for** and **broadcast** messages across event-driven systems.
# Documentation
See the [extension documentation](https://query.farm/duckdb_extension_radio.html).
## Building
### Managing dependencies
DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
```shell
cd
git clone https://github.com/Microsoft/vcpkg.git
sh ./vcpkg/scripts/bootstrap.sh -disableMetrics
export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
```
Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not work without removing the dependency.
### Build steps
Now to build the extension, run:
```sh
make
```
The main binaries that will be built are:
```sh
./build/release/duckdb
./build/release/test/unittest
./build/release/extension//.duckdb_extension
```
- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
- `.duckdb_extension` is the loadable binary as it would be distributed.
### Tips for speedy builds
DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid rebuilds.
To build using ninja and ccache ensure both are installed and run:
```sh
GEN=ninja make
```
## Running the extension
To run the extension code, simply start the shell with `./build/release/duckdb`. This shell will have the extension pre-loaded.
```
## Running the tests
Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL tests in `./test/sql`. These SQL tests can be run using:
```sh
make test
```