drizzle / synapse

Author: zoe-codez

docs/home-automation/synapse/index.md

@@ -18,6 +18,16 @@ Synapse has 2 major components to install in order to achieve proper functionali
 1. Custom component: [synapse-extension](/docs/home-automation/synapse/extension)
 2. Typescript library: [install guide](/docs/home-automation/synapse/install)
 
+## 🗄️ Database Support
+
+Synapse uses [Drizzle ORM](https://orm.drizzle.team/) to support multiple database types:
+
+- **SQLite** (default) - Local file-based storage
+- **PostgreSQL** - Production-ready relational database
+- **MySQL** - Alternative relational database
+
+Database configuration is handled through environment variables or application configuration. See the [configuration section](/docs/home-automation/synapse/usage/advanced#database-configuration) for details.
+
 ## 👩‍🔧 Basic Usage
 
 Creating a new entity is easy! You can even attach to events inline with

docs/home-automation/synapse/notes.md

@@ -49,8 +49,8 @@ HOME_AUTOMATION.bootstrap({
 
 - running BOTH setups at the same time may lead to undefined behavior
   - stop `prod` before starting `dev`
-- stored state in sqlite database is **NOT** automatically synced, and will match the machine
-- no critical information is stored in sqlite db, and it may be removed to "reset" at any time
+- stored state in database is **NOT** automatically synced, and will match the machine
+- no critical information is stored in the database, and it may be removed to "reset" at any time
 
 ## Sync not working
 
@@ -60,7 +60,7 @@ The fix for this is to fully reset the app/integration.
 1. remove device ([🖼️](/img/synapse_delete.png))
 2. stop your application
 3. reboot home assistant
-4. *optional:* remove synapse db
+4. *optional:* remove synapse database
 5. start app and re-add to home assistant
 
 ## 🛠️ Managed Domains

docs/home-automation/synapse/syncing.md

@@ -9,11 +9,11 @@ This document covers how `synapse` handles syncing state with Home Assistant, ma
 ## State Syncing
 
 The `synapse` library operates off of a **push** model. When making changes to entity configuration / locals:
-1. written to local sqlite database
+1. written to local database (SQLite by default, or PostgreSQL/MySQL)
 2. if change should be reflect in ha (state / config update), immediately emit via websocket event
 3. receive by python `synapse-extension`, and reflect change in entity config
 
-The sqlite database exists to track current state, it does not contain any historical information.
+The database exists to track current state, it does not contain any historical information.
 It's primary purpose to to restore state during application reboots (expected or otherwise), and it's data should reflect what is currently in memory by your app
 
 > **Note**: removing entities from code will **NOT** clean up from database automatically

docs/home-automation/synapse/usage/advanced.md

@@ -97,3 +97,40 @@ function MyService({ synapse, lifecycle }) {
   })
 }
 ```
+
+## 🗄️ Database Configuration
+
+Synapse supports multiple database types through Drizzle ORM. Configure your database using environment variables or application configuration:
+
+### Environment Variables
+
+```bash
+# Database type (sqlite, postgresql, mysql)
+SYNAPSE_DATABASE_TYPE=postgresql
+
+# Database connection URL
+SYNAPSE_DATABASE_URL=postgresql://user:password@localhost:5432/synapse
+```
+
+### Application Configuration
+
+```typescript
+HOME_AUTOMATION.bootstrap({
+  configuration: {
+    synapse: {
+      DATABASE_TYPE: "postgresql",
+      DATABASE_URL: "postgresql://user:password@localhost:5432/synapse"
+    }
+  },
+});
+```
+
+### Database Types
+
+| Type | Default URL | Description |
+|------|-------------|-------------|
+| `sqlite` | `file:./synapse_storage.db` | Local file-based storage |
+| `postgresql` | Custom | Production-ready relational database |
+| `mysql` | Custom | Alternative relational database |
+
+> **Note**: For PostgreSQL and MySQL, you must provide a valid connection URL in the `DATABASE_URL` environment variable.

docs/home-automation/synapse/usage/locals.md

@@ -5,7 +5,7 @@ sidebar_position: 5
 ---
 
 In addition to acting as entities for Home Assistant, `synapse` entities have the ability to store generic data locally.
-Data gets serialized and placed in the same sqlite database that maintains current state for your application.
+Data gets serialized and placed in the same database that maintains current state for your application.
 
 Updates to `locals` persist across boots of your application, and modifications do not trigger update events.
 The system operates the same way for all entity domains.