add docs for db and redis

This commit is contained in:
Joel Wetzell
2026-03-21 11:12:06 -05:00
parent 23aa7d81e0
commit 24f2b45e07
8 changed files with 126 additions and 2 deletions
+21
View File
@@ -0,0 +1,21 @@
---
title: SQLite
sidebar:
order: 1
---
The `db.sqlite` module can open/create SQLite databases
- **type**: `db.sqlite`
- **params**:
- **dsn**: the data source name, this can be a file path or the special `:memory:` name for an in-memory DB
## Cap
### Example snippet
Opens an in-memory SQLite database
```
- id: db
type: db.sqlite
params:
dsn: ":memory:"
```
+1 -1
View File
@@ -9,7 +9,7 @@ import { Aside } from '@astrojs/starlight/components';
This module is not currently included in the pre-compiled binaries for [showbridge](https://github.com/jwetzell/showbridge-go/releases/latest)
</Aside>
The `midi.output` module connects to a midi device (or virtual device) and allows sending MIDI messages out to that device. This module does not receive any message and so using it as an `input` to a [route](/concepts/routes) would be pointless.
The `midi.output` module connects to a midi device (or virtual device) and allows sending MIDI messages out to that device. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `midi.output`
- **params**:
@@ -3,7 +3,7 @@ title: UDP Client
sidebar:
order: 3
---
The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not receive any message and so using it as an `input` to a [route](/concepts/routes) would be pointless.
The `net.udp.client` module sends messages to a the configured `host` and `port`. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `net.udp.client`
- **params**:
+22
View File
@@ -0,0 +1,22 @@
---
title: Redis Client
sidebar:
order: 1
---
The `redis.client` module connects to a Redis server. This module does not produce any messages and so using it as an `input` to a [route](/concepts/routes) would be pointless.
- **type**: `redis.client`
- **params**:
- **host**: the Redis server host
- **port**: the Redis server port
### Example
Connect to a Redis server running on `localhost` at port `6379`.
```
- id: redisClient
type: redis.client
params:
host: "localhost"
port: 6379
```