Sqitch

Sqitch is the database migration tool driving Vibetype.

📋 Table of Contents

1. 🛠️ Quickstart
2. 📚 Documentation
3. 🚀 Preview

🛠️ Quickstart

Make sure you understand what Sqitch does, i.e. have a look into Sqitch's documentation.

This project is designed to be used within the maevsi/stack. To get started, follow the Vibetype fullstack setup guide. Once your development environment is running, use these commands to manage database migrations:

npm run deploy            # apply database migrations
npm run revert            # roll back database migrations

npm run test              # execute test suite
npm run test:data:add     # add test data migration
npm run test:data:remove  # remove test data migration
npm run test:update       # update test fixtures

After setup, you can inspect and test GraphQL queries and mutations using GraphiQL at https://postgraphile.localhost/graphiql.

💡 You can run npm run sqitch <command> [options] to access full Sqitch functionality.

🧊 If your terminal hangs while running the commands above, it may be related to IPv6 DNS configuration. To check if IPv6 DNS addresses are in use, run nmcli dev show | grep DNS and look for lines labeled IP6.DNS. Disabling IPv6, e.g. by commenting out ::1 localhost in your /etc/hosts file, may resolve the issue.

📚 Documentation

To fully understand the quick start commands above and Vibetype's database concepts, check out the onboarding and in-depth guides below.

🧭 Onboarding

1. Project
   1. Code Structure
   2. Contributing
   3. Code of Conduct
2. Database concepts
   1. Roles
   2. Row Level Security

🔍 In-Depth Guides

1. Project
   1. Code Structure
   2. Changelog
2. Database concepts
   1. Row Level Security
   2. Vacuuming

🚀 Preview

Here’s a visual overview of what Sqitch creates (click here to zoom in):