Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

docs: adr for db changes (#3439)

Browse Source
This commit is contained in:
Mateusz Kwasniewski 2023-04-11 14:16:40 +02:00 committed by GitHub
parent 358dcf1196
commit 536230a364
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
website/docs/contributing/ADRs/back-end/breaking-db-changes.md Normal file
View File

@ -0,0 +1,29 @@
---
title: "ADR: Braking DB changes"
---
## Background
During the evolution of a feature different clients may use different version of code e.g. behind a feature flag.
If the code relies on breaking DB changes (column delete, table rename, deleting DB entries etc.) it may lead to errors.
The very same problem occurs when you apply a breaking migration just before the new version of the application starts e.g. during a zero-downtime deployment (whatever strategy you use).
The code is still running against the old schema as the migration takes a few seconds to apply.
## Decision
First please make sure to avoid breaking DB changes in the first place if possible.
If breaking change is inevitable please use the "expand/contract" pattern.
In the "expand phase":
* maintain old and new DB schema in parallel
* maintain code that works with old and new DB schema
* keep it for 2 minor releases to give all clients a chance to upgrade the code
* with a fallback of 2 version we can also downgrade in this range without running down migrations
In the "contract phase":
* remove the old schema when you know that no client is using the old version
Action for a code reviewer:
* when you spot a migration with `ALTER table DROP COLUMN` or `ALTER table RENAME TO` please raise a flag if the "expand phase" was missed