https://github.com/maevsi/sqitch
Vibetype's database migrations.
https://github.com/maevsi/sqitch
hacktoberfest
Last synced: about 2 months ago
JSON representation
Vibetype's database migrations.
- Host: GitHub
- URL: https://github.com/maevsi/sqitch
- Owner: maevsi
- Created: 2023-05-12T22:00:08.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-20T12:32:12.000Z (about 2 months ago)
- Last Synced: 2026-04-20T14:42:17.114Z (about 2 months ago)
- Topics: hacktoberfest
- Language: PLpgSQL
- Homepage: https://maev.si
- Size: 7.79 MB
- Stars: 2
- Watchers: 4
- Forks: 4
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Sqitch
[
](https://sqitch.org/)
**[Sqitch](https://sqitch.org/)** is the database migration tool driving [Vibetype](https://github.com/maevsi/vibetype).
## 📋 Table of Contents
1. [🛠️ Quickstart](#🛠️-quickstart)
2. [📚 Documentation](#📚-documentation)
3. [🚀 Preview](#🚀-preview)
## 🛠️ Quickstart
Make sure you understand what Sqitch does, i.e. have a look into [Sqitch's documentation](https://sqitch.org/docs/).
This project is designed to be used within the [maevsi/stack](https://github.com/maevsi/stack).
To get started, follow the [Vibetype fullstack setup guide](https://github.com/maevsi/vibetype/blob/main/README.md#fullstack).
Once your development environment is running, use these commands to manage database migrations:
```sh
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 [options]` to access full Sqitch functionality.
## 📚 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](./docs/onboarding/project.md)
1. [Contributing](./CONTRIBUTING.md)
1. [Code of Conduct](./CODE_OF_CONDUCT.md)
1. **Database concepts**
1. [Roles](./docs/onboarding/database/roles.md)
1. [Row Level Security](./docs/onboarding/database/row_level_security.md)
### 🔍 In-Depth Guides
1. **Project**
1. [Code Structure](./docs/advanced/project.md)
1. [Changelog](./CHANGELOG.md)
1. **Database concepts**
1. [Row Level Security](./docs/advanced/database/row_level_security.md)
1. [Vacuuming](./docs/advanced/database/vacuum.md)
## 🚀 Preview
Here’s a visual overview of what Sqitch creates ([click here to zoom in](https://raw.githubusercontent.com/maevsi/sqitch/refs/heads/main/docs/resources/graph.png)):
[
](./docs/resources/graph.png)