SQLx Migration
Use the SQLx CLI to create migration files instead of manually creating timestamped files.
Instructions
Identify the project or crate root where SQLx migrations should live.
- Prefer the directory that contains an existing
migrations/directory. - If there are multiple crates/projects, ask the user which one unless the target is obvious.
- Prefer the directory that contains an existing
Convert the requested migration description to a short snake_case name, for example
create_users_table.Run
just setup_test_envsfrom the project rootRun the SQLx CLI from
crates/macro_db_clientfolder:cargo sqlx migrate add name_of_migrationReplace
name_of_migrationwith the actual snake_case migration name.Do not manually add timestamps or hand-create migration filenames;
sqlx migrate addgenerates the correct timestamped file.After the command succeeds, read the generated migration file and add the requested SQL changes there.
Before pushing, run the
migration-reviewskill on the finished file: it checks locks, rewrites, and compatibility with deployed code.If
sqlxis not installed or not onPATH, stop and tell the user to installsqlx-clirather than manually creating the migration file.