It’s been a while since my last post with the main reason being that things have gotten really busy at amper. In the past couple months, we’ve hired another software engineer and a data scientist. As you can imagine, moving from engineers working solo to teams requires more processes and tools to help maintain order and keep people from stepping on toes.
From the beginning, we’ve used things like continuous integration, unit-tests and version control for our code. Something that we’ve put off is applying similar principles to our database. We use a Postgres RDS instance hosted by AWS, and connect many of our services to it. When we’ve needed to make changes, it was a matter of jumping on the instance and manually writing SQL for table/index modifications. This has been fine with only two people on the team, but not with a team of six.
Growing our team is the main reason why we’ve started version controlling our database, but it’s not the only one. When I got started with this concept, I found Jeff Atwood’s blog post on version controlling the database to be very helpful. There are other resources as well that give some solid reasons for moving in that direction, and I won’t rehash them here.
We ended up going with flyway, a Java-based tool that helps with this process. It is built on using simple SQL scripts that are numbered and get applied sequentially to bring database schemas up-to-date. The documentation was decent at explaining the core functionality and usage of the tool, but I found resources for using flyway in a production environment to be lacking. The rest of this blog post will be about how amper uses flyway and integrates it into our workflows. I don’t claim that our usage is the standard, but it has been useful in getting ourselves up and running!
flyway in practice
One of the first confusing things that tripped us up was figuring out how to structure our repository. When you download flyway for the first time, it comes with many directories: some for config files, jars, sql and more. This is what the structure of our repository looks like. I’ll briefly go over what each section is responsible for below.
.circleci/ # holds our circleci build configurations
conf/ # holds all of our configuration files for database locations
seed/ # for storing timestamped dump data when developing
sql/ # where our sql migrations get stored
users/ # sql that holds the user accounts
initialize.sh # used to set up the db locally
install_flyway.sh # used to download, unzip and setup flyway
run_ci.sh # used by circleci to run sql against test db
seed.sh # adds the seed data to the local dev db
The first important directory is
conf/. Inside that directory, you’ll find
multiple configuration files that specify different database logins
depending on their name. For example, here is what my
factory_dev.conf file looks like:
These configuration files are pretty simple, and if you want to read more about configuration files, you can find documentation here. We use a separate configuration file for each development environment in order to make it clear when we are running migrations.
The next important directory is
sql/ - this directory is more
self-explanatory. It holds the numbered sql files that flyway uses to migrate
your database. The flyway documentation is pretty clear about how this works,
so I’ll leave that to you to figure out.
users/ we store sql scripts that hold the configuration for consistent
users for ourselves and our services. I create new credentials for each
service, along with fine-grained permissions based on what each service needs.
/* user accounts */
CREATE USER admin_user WITH PASSWORD 'fake_pass';
CREATE USER user1 WITH PASSWORD 'fake_pass';
CREATE USER service1 WITH PASSWORD 'fake_pass';
/* give all priv's to admin_user */
GRANT ALL PRIVILEGES ON DATABASE "test_db" to admin_user;
/* give read-only privileges to user1 */
GRANT SELECT ON ALL TABLES IN SCHEMA test_schema TO user1;
ALTER DEFAULT PRIVILEGES IN SCHEMA test_schema GRANT SELECT ON TABLES TO user1;
/* give read/write privileges to service1 */
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA test_schema TO service1;
ALTER DEFAULT PRIVILEGES IN SCHEMA test_schema GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO service1;
We keep this outside our SQL migrations to allow for us to maintain consistent
permissions across all of our servers. The credentials generated here are what
the configuration files use to connect/run migrations, so it’s a bit of
a chicken-and-egg problem. The
initialize.sh script in the root of our
directory automatically runs these permissions commands to save some time and
psql syntax lookups. This is definitely one of the more experimental
aspects of our flyway usage, so we’ll see how this evolves over time.
The rest of the contents in this directory are helper scripts that make common
actions a bit easier.
initialize.sh is used to ease getting a local
database up and running locally.
seed.sh makes it easy to load in seed data
seeds/ directory. We also include a script that our continous
integration tools use to automatically validate new migrations.
With the repository structure set up, let’s go over how we actually use flyway. I’ll go over two basic workflows, 1) initializing a local development database and 2) making changes to the production database schema.
When a new developer joins the team, or we’re setting up a new development machine, we follow this workflow. It’s not completely automated, but the most critical parts have been to help reduce human error.
- Set up a local instance of Postgres, this can be done with Docker, brew or any other packages.
- Manually create a database with the name that your dev configuration uses.
- Run the
initialize.shscript which takes care of user and schema initialization.
- Migrate the clean database to the current production schema with
- Optional: Add some seed data to the database by running the script
As you can see, it’s pretty simple, and it handles most of the complicated aspects for you. Once you have a database installed and running, our process takes care of almost all of it for you! We also use a similar flow when we want to blow our local DB and bring it back up to latest, especially after lots of testing.
The next most common workflow is actually making changes to the database. These steps assume that you already have the latest production schema running in your local database.
- Checkout a new branch in the database repo.
psqlor your favorite DB admin tool, modify the database to fit your requirements. Be sure to keep track of exactly what you did if you spent a bunch of time experimenting.
- Place all of your new changes in a sql file, and be sure to name it
following the flyway convention. By default, it requires numerically-ordered
files that look like this:
V001__some_change.sql. Add a new file and increment the latest version so that flyway can pick it up.
- Open a pull-request, and let the CI server pick up your changes and ensure that your sql runs without error.
- Merge the pull-request, and then run
flyway migrateagainst your production database.
This flow is also pretty simple, it makes it very clear for everyone to review what exactly you’re doing to the database. And while we don’t have complex migration validation with our CI (it uses an empty DB), we can at least validate that it is valid sql on an outside machine. Next, I’ll share a little more about how we’ve set up our testing flow.
Now that we can programmatically migrate our databases, the next step is to hook it up to some continuous tools to help validate your builds on a clean server. Our CI testing flow is pretty naive so it doesn’t ensure that existing data can be migrated, but it helps validate that the SQL is valid and can be run against the existing schema.
We keep a tiny RDS instance running at all times. When a new commit is pushed
to a remote branch, we run
flyway clean and then
flyway migrate against the
test db. By clearing any existing schemas, this lets us be sure that the SQL we
wrote will work against what exactly is in production. Like mentioned before,
this doesn’t migrate with seed data, but it gives us enough confidence that we
aren’t missing anything obvious.
I elected not to automatically deploy to production on merges, as there might be cases where we want to carry out additional spot testing. At our team-size, this hasn’t proven to be an issue as we aren’t altering the database multiple times a day. If you elect to move forward with automatic production deploys, it might be worth investing in automating testing of the existing APIs against the new schema to make sure there it is compatible.
So far, I’ve described our simple processes for managing our database schemas. For a small team, it works decently well, and helps keep everyone on the same page as we add, refactor, and remove old datastores. It also helps us find errors and easily see a working history of our databases’ evolution over time. That being said, there are a few areas that we’d like to improve as time permits:
improving the setup process
When onboarding new developers and setting up new machines, the setup process above is a bit complex and requires many steps. It is also quite easy to botch it if one isn’t careful. In the future we’d like to simplify the process, and also highlight exactly how flyway commands help us manage our schemas.
automating seed data
The seed data we currently have in our repo is manually generated using
pgdump and the
--schema-only flag. As you can imagine, this gets out of
date as our schema evolves and requires someone to occasionally bump this. In
an ideal world, we would have an automated weekly job that dumps production
data into an S3 bucket. Each snapshot would be tagged with the current schema
version, and when a seed command gets run, the tool would reconcile the schema
version and find the latest valid seed snapshot.
ci testing with real data
Similar to the above point, we would want our CI testing to also get seeded with the most recent production data. Once we’ve validated that our latest migration works against a prod mirror, we’d like to run integration tests from our API to ensure that it has the correct code needed for the new schema.
If you have ideas, feedback or more questions about how we do simple version control, feel free to reach out! When we developed this process, there wasn’t as much helpful documentation on the web as I thought there might be, so hopefully this gives you a concrete example. Good luck!