Merge pull request #4 from waku-org/feat/sqlite

feat: sqlite migration
This commit is contained in:
kaichao 2025-07-11 14:10:45 +08:00 committed by GitHub
commit 63a512dc42
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 67 additions and 1 deletions

11
.gitignore vendored
View File

@ -10,4 +10,13 @@ nimcache/
*.a
# OS
.DS_Store
.DS_Store
# Temporary files
*.db
# Compiled files
chat_sdk/*
!*.nim
apps/*
!*.nim

1
apps/nim.cfg Normal file
View File

@ -0,0 +1 @@
path = ".."

12
apps/run_migration.nim Normal file
View File

@ -0,0 +1,12 @@
import db_connector/db_sqlite
import chat_sdk/migration
proc main() =
let db = open("test.db", "", "", "")
defer:
db.close()
runMigrations(db)
when isMainModule:
main()

View File

@ -16,3 +16,6 @@ task buildSharedLib, "Build shared library for C bindings":
task buildStaticLib, "Build static library for C bindings":
exec "nim c --app:staticLib --out:../library/c-bindings/libchatsdk.a chat_sdk/chat_sdk.nim"
task migrate, "Run database migrations":
exec "nim c -r apps/run_migration.nim"

32
chat_sdk/migration.nim Normal file
View File

@ -0,0 +1,32 @@
import os, sequtils, algorithm
import db_connector/db_sqlite
import chronicles
proc ensureMigrationTable(db: DbConn) =
db.exec(sql"""
CREATE TABLE IF NOT EXISTS schema_migrations (
filename TEXT PRIMARY KEY,
applied_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
)
""")
proc hasMigrationRun(db: DbConn, filename: string): bool =
for row in db.fastRows(sql"SELECT 1 FROM schema_migrations WHERE filename = ?", filename):
return true
return false
proc markMigrationRun(db: DbConn, filename: string) =
db.exec(sql"INSERT INTO schema_migrations (filename) VALUES (?)", filename)
proc runMigrations*(db: DbConn, dir = "migrations") =
info "Migration process starting up"
ensureMigrationTable(db)
let files = walkFiles(dir / "*.sql").toSeq().sorted()
for file in files:
if hasMigrationRun(db, file):
info "Migration already applied", file
else:
info "Applying migration", file
let sql = readFile(file)
db.exec(sql(sql))
markMigrationRun(db, file)

9
migrations/README.md Normal file
View File

@ -0,0 +1,9 @@
## Database Migrations
This directory contains SQL migration files for the Nim Chat SDK.
Each migration file should be named in the format `NNN_description.sql`, where `NNN` is a zero-padded number indicating the order of the migration. For example, `001_create_user_table.sql` is the first migration.
## Running Migrations
If you want to install a test sqlite database with tables setup, you can run `nimble migrate` from the command line. This will execute all migration files in order, ensuring that your database schema is up to date.