Skip to content

migration clarifications #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tstirrat15 merged 1 commit into from
Nov 25, 2025
Merged

migration clarifications #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pages/spicedb/concepts/datastore-migrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Updates are published to the [SpiceDB GitHub releases page] and announced via [T
Transitioning between versions is often as simple as executing a new binary or container, but there are times when updates are more complex.
For example, releases that include changes to datastore can require that users update to specific versions and perform a series of actions in order to update while avoiding any downtime.

<Callout type="info">
This page explains migrating the schema of a datastore underlying SpiceDB. If you need information about migrating between SpiceDB instances, go [here](/spicedb/ops/data/migrations). If you need information about making changes to a SpiceDB schema that result in a migration, go [here](/spicedb/modeling/migrating-schema).
</Callout>

<Callout type="warning">
SpiceDB strives to main compatibility across each version and its following minor version.

Expand Down
6 changes: 5 additions & 1 deletion pages/spicedb/modeling/migrating-schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { Callout } from 'nextra/components';

# Updating Migrating Schema in SpiceDB
# Updating and Migrating Schema in SpiceDB

<Callout type="info">
This page explains how to modify a SpiceDB schema. If you need information about migrating the schema of a datastore underlying SpiceDB, like Postgres or CockroachDB, go [here](/spicedb/concepts/datastore-migrations#migrations). If you need information about migrating between SpiceDB instances, go [here](/spicedb/ops/data/migrations).
</Callout>

[Schema] in SpiceDB represents the structural definitions of which relationships are allowed
in SpiceDB and how permissions are computed.
Expand Down
5 changes: 5 additions & 0 deletions pages/spicedb/ops/data/migrations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@ import { Callout } from 'nextra/components'

# Migrations


## Migrating from SpiceDB to SpiceDB

<Callout type="info">
This section covers migrating data from one SpiceDB instance to another. If you need information about migrating the schema of a datastore underlying SpiceDB, like Postgres or CockroachDB, go [here](/spicedb/concepts/datastore-migrations#migrations). If you need information about making changes to a SpiceDB schema that result in a migration, go [here](/spicedb/modeling/migrating-schema).
</Callout>

<Callout type="warning">
Migrating data at the underlying database level is not recommended and impossible in some cases. Using tools like `pg_dump`/`pg_restore` will break SpiceDB MVCC. Additionally, if you are migrating to a SpiceDB with a different datastore type (e.g. Postgres -> CockroachDB), you ***must*** use the SpiceDB APIs (`exportBulk`/`importBulk` or `zed backup`) to backup and restore.
</Callout>
Expand Down
Loading