Skip to content

Commit 94a5e7f

Browse files
kvchandrew-farries
andauthored
Add new page to documentation titled "Why use pgroll?" (#806)
This PR adds a short page that calls out the benefits of using pgroll. It is the part of the new, quicker onboarding experience in the documenation. --------- Co-authored-by: Andrew Farries <[email protected]>
1 parent 0d3f57d commit 94a5e7f

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
"href": "/getting-started",
66
"file": "docs/getting-started.md"
77
},
8+
{
9+
"title": "Why use pgroll",
10+
"href": "/why-use-pgroll",
11+
"file": "docs/why-use-pgroll.md"
12+
},
813
{
914
"title": "Installation",
1015
"href": "/installation",

docs/why-use-pgroll.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Why use pgroll?
2+
3+
[pgroll](https://pgroll.com/) is a schema migration tool for Postgres. It is designed for application developers working on applications that require frequent schema changes but also need to maintain zero downtime around those schema changes. `pgroll` takes a different approach compared to most other migration tools on the market.
4+
5+
There are two aspects that characterize `pgroll`'s approach to migrations.
6+
7+
## Multi-version migrations
8+
9+
Making a schema change with `pgroll` results in two versions of the schema; the one before the change and the one after the change - this allows applications to select which version of the schema they want to work with and allows side-by-side rollout of applications that require the new schema changes with old applications that may be incompatible with it.
10+
11+
## Lock-safe migrations
12+
13+
Migrations using `pgroll` are expressed declaratively, rather than using SQL directly. This allows `pgroll` to implement the steps required to perform the schema change in a safe manner, ensuring that any locks required on the affected objects are held for the shortest possible time.
14+
15+
If you want to avoid worrying about schema changes, install `pgroll` and create your next migration with us.

0 commit comments

Comments
 (0)