wehub-resource-sync
0d3cb498a3
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
69 lines
2.2 KiB
Markdown
69 lines
2.2 KiB
Markdown
# Database Migrations
|
|
|
|
**What this is:** Drizzle ORM migration files for SQLite database. Auto-generated SQL that applies schema changes.
|
|
|
|
## Schema is NOT Here
|
|
|
|
**Schema definitions are in `src/database/tables.ts`, NOT in this directory.**
|
|
|
|
This directory only contains generated SQL migration files.
|
|
|
|
## Migration Workflow
|
|
|
|
1. **Modify schema** in `src/database/tables.ts`
|
|
2. **Generate migration:** `npm run db:generate`
|
|
3. **Review SQL** in new `drizzle/NNNN_name.sql` file
|
|
4. **Apply migration:** `npm run db:migrate`
|
|
|
|
## File Naming
|
|
|
|
Drizzle auto-generates names: `NNNN_adjective_noun.sql`
|
|
|
|
- `0000_lush_hellion.sql`
|
|
- `0001_wide_calypso.sql`
|
|
- Sequential numbering ensures order
|
|
|
|
## Key Commands
|
|
|
|
```bash
|
|
npm run db:generate # Generate migration from schema changes
|
|
npm run db:migrate # Apply pending migrations
|
|
npm run db:studio # Open GUI at localhost:4983
|
|
```
|
|
|
|
## Database Location
|
|
|
|
Default: `~/.promptfoo/promptfoo.db` (SQLite file)
|
|
|
|
Override the config directory with `PROMPTFOO_CONFIG_DIR`; the database file is `promptfoo.db` inside that directory.
|
|
|
|
**NEVER delete the database.** You may read from it but deletion destroys user data.
|
|
|
|
## SQLite Limitations
|
|
|
|
**Cannot drop columns** - SQLite doesn't support `ALTER TABLE DROP COLUMN`.
|
|
|
|
Workaround: Create new table, copy data, drop old table, rename new table.
|
|
|
|
**Cannot rename columns** (older SQLite) - Same workaround as drop column.
|
|
|
|
## Migration Best Practices
|
|
|
|
1. **Always review generated SQL** before applying
|
|
2. **Never edit applied migrations** - create new migration instead
|
|
3. **Backup before major changes:** `sqlite3 ~/.promptfoo/promptfoo.db ".backup backup.db"`
|
|
4. **Test schema changes with isolated storage**: unit tests should use the shared in-memory DB; CLI, resume, WAL, and path-behavior tests may use an isolated `PROMPTFOO_CONFIG_DIR`
|
|
|
|
## What's Stored
|
|
|
|
- Evaluation results and test configurations
|
|
- Execution traces for debugging
|
|
- Analytics data and telemetry
|
|
- User settings and preferences
|
|
|
|
## Tech Stack
|
|
|
|
- **Drizzle ORM** - Type-safe schema and migrations
|
|
- **@libsql/client** - Async SQLite/libSQL driver. `getDb()` returns a Promise (`src/database/index.ts`), so always `await getDb()` before database work.
|
|
- **SQLite / libSQL** - Embedded database
|