chore: remove revision from Durable State primary key (#559)

* chore: remove revision from Durable State primary key
akka · Apr 23, 2024 · d579807 · d579807
1 parent bb19e4f
commit d579807
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 8 deletions.
diff --git a/ddl-scripts/create_tables_postgres.sql b/ddl-scripts/create_tables_postgres.sql
@@ -57,7 +57,7 @@ CREATE TABLE IF NOT EXISTS durable_state (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/ddl-scripts/create_tables_postgres_0-1.sql b/ddl-scripts/create_tables_postgres_0-1.sql
@@ -102,7 +102,7 @@ CREATE TABLE IF NOT EXISTS durable_state_0 (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 CREATE TABLE IF NOT EXISTS durable_state_1 (
@@ -117,7 +117,7 @@ CREATE TABLE IF NOT EXISTS durable_state_1 (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/ddl-scripts/create_tables_postgres_2-3.sql b/ddl-scripts/create_tables_postgres_2-3.sql
@@ -102,7 +102,7 @@ CREATE TABLE IF NOT EXISTS durable_state_2 (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 CREATE TABLE IF NOT EXISTS durable_state_3 (
@@ -117,7 +117,7 @@ CREATE TABLE IF NOT EXISTS durable_state_3 (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/ddl-scripts/create_tables_postgres_jsonb.sql b/ddl-scripts/create_tables_postgres_jsonb.sql
@@ -57,7 +57,7 @@ CREATE TABLE IF NOT EXISTS durable_state (
   state_payload JSONB NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id, revision)
+  PRIMARY KEY(persistence_id)
 );
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/ddl-scripts/create_tables_sqlserver.sql b/ddl-scripts/create_tables_sqlserver.sql
@@ -61,7 +61,7 @@ IF object_id('durable_state') is null
 	  state_payload VARBINARY(MAX) NOT NULL,
 	  tags NVARCHAR(255),
 
-	  PRIMARY KEY(persistence_id, revision)
+	  PRIMARY KEY(persistence_id)
 	);
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/ddl-scripts/create_tables_yugabyte.sql b/ddl-scripts/create_tables_yugabyte.sql
@@ -59,7 +59,7 @@ CREATE TABLE IF NOT EXISTS durable_state (
   state_payload BYTEA NOT NULL,
   tags TEXT ARRAY,
 
-  PRIMARY KEY(persistence_id HASH, revision ASC)
+  PRIMARY KEY(persistence_id HASH)
 );
 
 -- `durable_state_slice_idx` is only needed if the slice based queries are used

diff --git a/docs/src/main/paradox/migration-guide.md b/docs/src/main/paradox/migration-guide.md
@@ -1,5 +1,21 @@
 # Migration Guide
 
+## 1.2.x to 1.3.0
+
+### Durable State table schema change (optional)
+The existing primary key for the Durable State table was containing an unnecessary column.
+
+Please run the following query to update the table constraint:
+
+Postgres / Yugabyte:
+: ```sql
+ALTER TABLE "durable_state"
+DROP CONSTRAINT durable_state_pkey,
+ADD PRIMARY KEY(persistence_id);
+```
+
+If you are using @ref[data partitioning](./data-partition.md), please make sure to apply the change to all tables.
+
 ## 1.1.x to 1.2.0
 
 ### Configuration file changes