Skip to content

Add notes on DB migration compatibility#310

Merged
tstirrat15 merged 1 commit intomainfrom
db-migration-compatibility
Feb 7, 2025
Merged

Add notes on DB migration compatibility#310
tstirrat15 merged 1 commit intomainfrom
db-migration-compatibility

Conversation

@tstirrat15
Copy link
Collaborator

Description

This came up in a discord conversation and I was uncertain of the behavior. I went and asked around and figured I'd document here.

Changes

  • Add section on DB migration compatibility

Testing

Review

@vercel
Copy link
Contributor

vercel bot commented Feb 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 5:53pm

On startup, SpiceDB checks to see whether its desired DB migration tag matches the DB migration tag held in the database.
If they differ, the instance will error out, which prevents an instance from coming up when it can't run against the current datastore DDL.

SpiceDB only performs this check on startup, which means that a new DB migration won't cause existing SpiceDB instances to break,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"but will impact those instances if restarted"

@tstirrat15 tstirrat15 force-pushed the db-migration-compatibility branch from 5058da1 to a061df4 Compare February 7, 2025 17:52
@tstirrat15 tstirrat15 merged commit e0a43b9 into main Feb 7, 2025
9 checks passed
@tstirrat15 tstirrat15 deleted the db-migration-compatibility branch February 7, 2025 17:55
@github-actions github-actions bot locked and limited conversation to collaborators Feb 7, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants