summaryrefslogtreecommitdiff
path: root/migrations/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'migrations/README.md')
-rw-r--r--migrations/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/migrations/README.md b/migrations/README.md
new file mode 100644
index 0000000..e849b9c
--- /dev/null
+++ b/migrations/README.md
@@ -0,0 +1,36 @@
+# Database Migrations
+
+Sequential SQL migrations for task-dashboard schema evolution.
+
+## Migration History
+
+| # | File | Purpose |
+|---|------|---------|
+| 001 | `001_initial_schema.sql` | Initial schema (tasks, boards, cards, meals) |
+| 002 | `002_add_cache_metadata.sql` | Cache metadata table for TTL tracking |
+| 003 | `003_add_sync_tokens.sql` | Sync tokens for incremental sync |
+| 004 | `004_add_auth.sql` | Authentication (users, sessions) |
+| 005 | `005_add_bugs.sql` | Bug tracking table |
+| 006 | `006_remove_resolved_bugs.sql` | Add resolved_at timestamp to bugs |
+| 007 | — | **SKIPPED** (reserved, never used) |
+| 008 | `008_user_shopping_items.sql` | User-added shopping items |
+| 009 | `009_shopping_item_checks.sql` | External item check state |
+| 010 | `010_agent_tables.sql` | Agent authentication (agents, agent_sessions) |
+| 011 | `011_completed_tasks.sql` | Completed tasks log |
+| 012 | `012_feature_toggles.sql` | Feature toggle system |
+| 013 | `013_source_config.sql` | Source filtering configuration |
+
+## Migration 007 Gap
+
+Migration 007 was reserved during development but never implemented. The gap is intentional and preserved to maintain clean git history. Future migrations continue from 014.
+
+## Running Migrations
+
+Migrations are applied automatically on application startup via `store.RunMigrations()`. The `schema_migrations` table tracks which migrations have been applied.
+
+## Creating New Migrations
+
+1. Create file: `migrations/NNN_description.sql` (next number is 014)
+2. Write idempotent SQL (use `IF NOT EXISTS` where possible)
+3. Test locally: `go run cmd/dashboard/main.go`
+4. Verify: Check `schema_migrations` table for new entry