unity-db

Development

Setup local database

Assuming you have docker-compose and make installed:

1. Start the local PostgreSQL database:

   make up

   This will use local-postgres-docker-compose.yml to start PostgreSQL 17.

2. Dump data from production (if needed):

   make dump

3. Restore dump into local db (if needed):

   make restore

4. Configure environment:

   • Copy .env.example to .env.local
   • Default local connection values should work unless you changed the docker-compose configuration

5. Database Migrations:

   • Write migrations in the migrations folder following chronological order
   • Test migrations locally with bun migrate
   • Commit changes in a PR
   • After merge, production db will be automatically migrated

Database Details

• Using PostgreSQL 17
• Default local credentials:
  • Host: localhost
  • Port: 5432
  • User: unity_user
  • Password: unity_password
  • Database: unity_db

Common Tasks

Reset local database:

make down
make up

Access PostgreSQL CLI:

docker exec -it unity_db_postgres psql -U unity_user -d unity_db