We use Sqitch to manage our database
schemas. For general help on how to use Sqitch and a bit about how it
works, see the sqitch SQLite
tutorial.
The following guide assumes you're running sqitch and the
primer-sqitch helper script from the nix develop shell.
Before running any Sqitch commands locally, you need to configure it with your name and email address. Note that you need only do this once per machine where you run Sqitch:
sqitch config --user user.name "Your Name"
sqitch config --user user.email [email protected]Making schema changes to the Primer Sqitch configuration is out of
scope for this document. See the Sqitch documentation for multiple
engines
for guidance, and note that we use the "separate plans" approach
described therein. Any Sqitch commands that modify the schema should
be run in the sqitch subdirectory of this repo.
We provide a few Sqitch scripts for common Sqitch operations, in
addition to a primer-sqitch wrapper script that bundles a copy of
the project's Sqitch config. We recommend that you at least use the
primer-sqitch command rather than running raw sqitch when working
with the Primer database. These commands are available in the nix develop
shell, and can be run as Flake apps, as well; e.g., nix run .#primer-sqitch ...
However, one drawback of this Nix-based approach is that if you're
making local changes to the Sqitch schema, you'll need to make sure
that the scripts in your Nix shell incorporate your changes. This
won't happen automatically in most cases, so either you'll need to
exit and re-enter the Nix shell again; or, if you're using direnv
with Nix flake support, run touch flake.nix.