Skip to content

Commit 92f6b96

Browse files
authored
migration clarification (#416)
1 parent 3f22e0b commit 92f6b96

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

pages/spicedb/concepts/datastore-migrations.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Updates are published to the [SpiceDB GitHub releases page] and announced via [T
88
Transitioning between versions is often as simple as executing a new binary or container, but there are times when updates are more complex.
99
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.
1010

11+
<Callout type="info">
12+
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).
13+
</Callout>
14+
1115
<Callout type="warning">
1216
SpiceDB strives to main compatibility across each version and its following minor version.
1317

pages/spicedb/modeling/migrating-schema.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
import { Callout } from 'nextra/components';
22

3-
# Updating Migrating Schema in SpiceDB
3+
# Updating and Migrating Schema in SpiceDB
4+
5+
<Callout type="info">
6+
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).
7+
</Callout>
48

59
[Schema] in SpiceDB represents the structural definitions of which relationships are allowed
610
in SpiceDB and how permissions are computed.

pages/spicedb/ops/data/migrations.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@ import { Callout } from 'nextra/components'
22

33
# Migrations
44

5+
56
## Migrating from SpiceDB to SpiceDB
67

8+
<Callout type="info">
9+
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).
10+
</Callout>
11+
712
<Callout type="warning">
813
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.
914
</Callout>

0 commit comments

Comments
 (0)