feat(postgres,cocroach): added replica identity

drizzle-kit/src/dialects/cockroach/convertor.ts

@@ -715,6 +715,20 @@ const toggleRlsConvertor = convertor('alter_rls', (st) => {
 	return `ALTER TABLE ${tableNameWithSchema} ${isRlsEnabled ? 'ENABLE' : 'DISABLE'} ROW LEVEL SECURITY;`;
 });
 
+const replicaIdentityConvertor = convertor('alter_replica_identity', (st) => {
+	const { schema, name, replicaIdentity } = st;
+
+	const tableNameWithSchema = schema !== 'public' ? `"${schema}"."${name}"` : `"${name}"`;
+
+	const clause = !replicaIdentity
+		? 'DEFAULT'
+		: replicaIdentity.type === 'index'
+		? `USING INDEX "${replicaIdentity.index}"`
+		: replicaIdentity.type.toUpperCase();
+
+	return `ALTER TABLE ${tableNameWithSchema} REPLICA IDENTITY ${clause};`;
+});
+
 const convertors = [
 	createSchemaConvertor,
 	dropSchemaConvertor,
@@ -767,6 +781,7 @@ const convertors = [
 	alterPolicyConvertor,
 	recreatePolicy,
 	toggleRlsConvertor,
+	replicaIdentityConvertor,
 	alterPrimaryKeyConvertor,
 	alterColumnAddNotNullConvertor,
 	alterColumnDropNotNullConvertor,

drizzle-kit/src/dialects/cockroach/ddl.ts

@@ -6,7 +6,11 @@ import { defaults } from './grammar';
 export const createDDL = () => {
 	return create({
 		schemas: {},
-		tables: { schema: 'required', isRlsEnabled: 'boolean' },
+		tables: {
+			schema: 'required',
+			isRlsEnabled: 'boolean',
+			replicaIdentity: { type: ['full', 'nothing', 'index'], index: 'string?' },
+		},
 		enums: {
 			schema: 'required',
 			values: 'string[]',
@@ -138,6 +142,7 @@ export type Table = {
 	checks: CheckConstraint[];
 	policies: Policy[];
 	isRlsEnabled: boolean;
+	replicaIdentity: CockroachEntities['tables']['replicaIdentity'];
 };
 
 export type InterimColumn = Omit<Column, 'primaryKey'> & {

drizzle-kit/src/dialects/cockroach/diff.ts

@@ -764,6 +764,30 @@ export const ddlDiff = async (
 			}
 		});
 
+	// replica identity: set for newly created tables (after indexes are created, see ordering below)
+	// and altered for existing tables when it changes
+	const jsonAlterReplicaIdentityStatements = [
+		...createdTables
+			.filter((it) => it.replicaIdentity)
+			.map((it) =>
+				prepareStatement('alter_replica_identity', {
+					schema: it.schema,
+					name: it.name,
+					replicaIdentity: it.replicaIdentity,
+				})
+			),
+		...alters
+			.filter((it) => it.entityType === 'tables')
+			.filter((it) => it.replicaIdentity)
+			.map((it) =>
+				prepareStatement('alter_replica_identity', {
+					schema: it.schema,
+					name: it.name,
+					replicaIdentity: it.replicaIdentity?.to ?? null,
+				})
+			),
+	];
+
 	// explicit rls alters
 	const rlsAlters = alters.filter((it) => it.entityType === 'tables').filter((it) => it.isRlsEnabled);
 
@@ -1063,6 +1087,8 @@ export const ddlDiff = async (
 	jsonStatements.push(...jsonRecreateFKs);
 	jsonStatements.push(...jsonCreateIndexes);
 
+	jsonStatements.push(...jsonAlterReplicaIdentityStatements); // after indexes for `USING INDEX` to resolve
+
 	jsonStatements.push(...jsonDropColumnsStatemets);
 
 	jsonStatements.push(...jsonCreatedCheckConstraints);

drizzle-kit/src/dialects/cockroach/drizzle.ts

@@ -62,6 +62,15 @@ import {
 	typeFor,
 } from './grammar';
 
+export const replicaIdentityFrom = (
+	replicaIdentity: ReturnType<typeof getTableConfig>['replicaIdentity'],
+): CockroachEntities['tables']['replicaIdentity'] => {
+	if (!replicaIdentity || replicaIdentity === 'default') return null;
+	if (replicaIdentity === 'full') return { type: 'full', index: null };
+	if (replicaIdentity === 'nothing') return { type: 'nothing', index: null };
+	return { type: 'index', index: replicaIdentity.usingIndex };
+};
+
 export const policyFrom = (policy: CockroachPolicy, dialect: CockroachDialect) => {
 	const mappedTo = !policy.to
 		? ['public']
@@ -280,6 +289,7 @@ export const fromDrizzleSchema = (
 			schema,
 			name: config.name,
 			isRlsEnabled,
+			replicaIdentity: replicaIdentityFrom(config.replicaIdentity),
 		} satisfies CockroachEntities['tables'];
 	});
 

drizzle-kit/src/dialects/cockroach/introspect.ts

@@ -128,6 +128,9 @@ export const fromDatabase = async (
 			accessMethod: number;
 			options: string[] | null;
 			rlsEnabled: boolean;
+			/* d - default, n - nothing, f - full, i - index */
+			replicaIdentity: 'd' | 'n' | 'f' | 'i';
+			replicaIdentityIndex: string | null;
 			tablespaceid: number;
 			definition: string | null;
 		}>(
@@ -141,6 +144,14 @@ export const fromDatabase = async (
 				reloptions::text[] as "options",
 				reltablespace as "tablespaceid",
 				relrowsecurity AS "rlsEnabled",
+				relreplident::text AS "replicaIdentity",
+				(
+					SELECT ci.relname
+					FROM pg_catalog.pg_index i
+					JOIN pg_catalog.pg_class ci ON ci.oid OPERATOR(pg_catalog.=) i.indexrelid
+					WHERE i.indrelid OPERATOR(pg_catalog.=) pg_class.oid AND i.indisreplident
+					LIMIT 1
+				) AS "replicaIdentityIndex",
 				CASE
 					WHEN relkind OPERATOR(pg_catalog.=) 'v' OR relkind OPERATOR(pg_catalog.=) 'm'
 						THEN pg_catalog.pg_get_viewdef(pg_class.oid, true)
@@ -191,6 +202,13 @@ export const fromDatabase = async (
 			schema: table.schema,
 			name: table.name,
 			isRlsEnabled: table.rlsEnabled,
+			replicaIdentity: table.replicaIdentity === 'f'
+				? { type: 'full', index: null }
+				: table.replicaIdentity === 'n'
+				? { type: 'nothing', index: null }
+				: table.replicaIdentity === 'i'
+				? { type: 'index', index: table.replicaIdentityIndex }
+				: null,
 		});
 	}
 

drizzle-kit/src/dialects/cockroach/statements.ts

@@ -1,6 +1,7 @@
 import type { Simplify } from '../../utils';
 import type {
 	CheckConstraint,
+	CockroachEntities,
 	Column,
 	DiffEntities,
 	Enum,
@@ -182,6 +183,13 @@ export interface JsonAlterRLS {
 	isRlsEnabled: boolean;
 }
 
+export interface JsonAlterReplicaIdentity {
+	type: 'alter_replica_identity';
+	schema: string;
+	name: string;
+	replicaIdentity: CockroachEntities['tables']['replicaIdentity'];
+}
+
 export interface JsonAlterPolicy {
 	type: 'alter_policy';
 	diff: DiffEntities['policies'];
@@ -423,6 +431,7 @@ export type JsonStatement =
 	| JsonRecreatePolicy
 	| JsonRenamePolicy
 	| JsonAlterRLS
+	| JsonAlterReplicaIdentity
 	| JsonRenameRole
 	| JsonCreateRole
 	| JsonDropRole

drizzle-kit/src/dialects/cockroach/typescript.ts

@@ -377,7 +377,13 @@ export const ddlToTypeScript = (ddl: CockroachDDL, columnsForViews: ViewColumn[]
 			statement += createTableChecks(table.checks, casing);
 			statement += ']';
 		}
-		statement += ');';
+		statement += ')';
+		if (table.replicaIdentity) {
+			statement += table.replicaIdentity.type === 'index'
+				? `.replicaIdentity({ usingIndex: "${table.replicaIdentity.index}" })`
+				: `.replicaIdentity("${table.replicaIdentity.type}")`;
+		}
+		statement += ';';
 		return statement;
 	});
 

drizzle-kit/src/dialects/postgres/aws-introspect.ts

@@ -166,6 +166,9 @@ export const fromDatabase = async (
 		accessMethod: string;
 		options: string[] | null;
 		rlsEnabled: boolean;
+		/* d - default, n - nothing, f - full, i - index */
+		replicaIdentity: 'd' | 'n' | 'f' | 'i';
+		replicaIdentityIndex: string | null;
 		tablespaceid: string;
 		definition: string | null;
 	};
@@ -181,6 +184,14 @@ export const fromDatabase = async (
                     reloptions::text[] as "options",
                     reltablespace as "tablespaceid",
                     relrowsecurity AS "rlsEnabled",
+                    relreplident::text AS "replicaIdentity",
+                    (
+                        SELECT ci.relname
+                        FROM pg_catalog.pg_index i
+                        JOIN pg_catalog.pg_class ci ON ci.oid OPERATOR(pg_catalog.=) i.indexrelid
+                        WHERE i.indrelid OPERATOR(pg_catalog.=) pg_class.oid AND i.indisreplident
+                        LIMIT 1
+                    ) AS "replicaIdentityIndex",
                     CASE
                         WHEN relkind OPERATOR(pg_catalog.=) 'v' OR relkind OPERATOR(pg_catalog.=) 'm'
                             THEN pg_catalog.pg_get_viewdef(pg_class.oid, true)
@@ -225,6 +236,13 @@ export const fromDatabase = async (
 			schema: trimChar(table.schema, "'"),
 			name: table.name,
 			isRlsEnabled: table.rlsEnabled,
+			replicaIdentity: table.replicaIdentity === 'f'
+				? { type: 'full', index: null }
+				: table.replicaIdentity === 'n'
+				? { type: 'nothing', index: null }
+				: table.replicaIdentity === 'i'
+				? { type: 'index', index: table.replicaIdentityIndex }
+				: null,
 		});
 	}
 

drizzle-kit/src/dialects/postgres/commutativity.ts

@@ -165,6 +165,7 @@ class PostgresCommutativity extends AbstractCommutativity<
 		'alter_policy',
 		'recreate_policy',
 		'alter_rls',
+		'alter_replica_identity',
 		'grant_privilege',
 		'revoke_privilege',
 		'regrant_privilege',
@@ -599,6 +600,15 @@ class PostgresCommutativity extends AbstractCommutativity<
 				}),
 			},
 
+			// Replica identity operations
+			alter_replica_identity: {
+				conflicts: ['alter_replica_identity'],
+				buildInfo: (statement) => ({
+					primary: makeTableTarget((statement as any).schema, (statement as any).name),
+					ancestors: [],
+				}),
+			},
+
 			// Role operations
 			create_role: {
 				conflicts: ['create_role', 'drop_role', 'rename_role', 'alter_role'],

drizzle-kit/src/dialects/postgres/convertor.ts

@@ -1038,6 +1038,22 @@ const toggleRlsConvertor = convertor('alter_rls', (st) => {
 	return `ALTER TABLE ${tableNameWithSchema} ${isRlsEnabled ? 'ENABLE' : 'DISABLE'} ROW LEVEL SECURITY;`;
 });
 
+const replicaIdentityConvertor = convertor('alter_replica_identity', (st) => {
+	const { schema, name, replicaIdentity } = st;
+
+	const tableNameWithSchema = schema !== 'public'
+		? `"${schema}"."${name}"`
+		: `"${name}"`;
+
+	const clause = !replicaIdentity
+		? 'DEFAULT'
+		: replicaIdentity.type === 'index'
+		? `USING INDEX "${replicaIdentity.index}"`
+		: replicaIdentity.type.toUpperCase();
+
+	return `ALTER TABLE ${tableNameWithSchema} REPLICA IDENTITY ${clause};`;
+});
+
 const convertors = [
 	createSchemaConvertor,
 	dropSchemaConvertor,
@@ -1097,6 +1113,7 @@ const convertors = [
 	alterPolicyConvertor,
 	recreatePolicy,
 	toggleRlsConvertor,
+	replicaIdentityConvertor,
 ];
 
 export function fromJson(

drizzle-kit/src/dialects/postgres/ddl.ts

@@ -5,7 +5,11 @@ import { defaultNameForPK, defaultNameForUnique } from './grammar';
 export const createDDL = () => {
 	return create({
 		schemas: {},
-		tables: { schema: 'required', isRlsEnabled: 'boolean' },
+		tables: {
+			schema: 'required',
+			isRlsEnabled: 'boolean',
+			replicaIdentity: { type: ['full', 'nothing', 'index'], index: 'string?' },
+		},
 		enums: {
 			schema: 'required',
 			values: 'string[]',
@@ -201,6 +205,7 @@ export type Table = {
 	checks: CheckConstraint[];
 	policies: Policy[];
 	isRlsEnabled: boolean;
+	replicaIdentity: PostgresEntities['tables']['replicaIdentity'];
 };
 
 export type InterimColumn = Omit<Column, 'primaryKey'> & {

drizzle-kit/src/dialects/postgres/diff.ts

@@ -937,6 +937,30 @@ export const ddlDiff = async (
 		},
 	);
 
+	// replica identity: set for newly created tables (after indexes are created, see ordering below)
+	// and altered for existing tables when it changes
+	const jsonAlterReplicaIdentityStatements = [
+		...createdTables
+			.filter((it) => it.replicaIdentity)
+			.map((it) =>
+				prepareStatement('alter_replica_identity', {
+					schema: it.schema,
+					name: it.name,
+					replicaIdentity: it.replicaIdentity,
+				})
+			),
+		...alters
+			.filter((it) => it.entityType === 'tables')
+			.filter((it) => it.replicaIdentity)
+			.map((it) =>
+				prepareStatement('alter_replica_identity', {
+					schema: it.schema,
+					name: it.name,
+					replicaIdentity: it.replicaIdentity?.to ?? null,
+				})
+			),
+	];
+
 	// explicit rls alters
 	const rlsAlters = alters.filter((it) => it.entityType === 'tables').filter((it) => it.isRlsEnabled);
 
@@ -1267,6 +1291,8 @@ export const ddlDiff = async (
 	jsonStatements.push(...jsonAlteredUniqueConstraints);
 	jsonStatements.push(...jsonCreateIndexes); // above fks for uniqueness constraint to come first
 
+	jsonStatements.push(...jsonAlterReplicaIdentityStatements); // after indexes for `USING INDEX` to resolve
+
 	jsonStatements.push(...jsonCreateFKs);
 	jsonStatements.push(...jsonRecreateFKs);
 

drizzle-kit/src/dialects/postgres/drizzle.ts

@@ -71,6 +71,15 @@ import {
 	typeFor,
 } from './grammar';
 
+export const replicaIdentityFrom = (
+	replicaIdentity: ReturnType<typeof getTableConfig>['replicaIdentity'],
+): PostgresEntities['tables']['replicaIdentity'] => {
+	if (!replicaIdentity || replicaIdentity === 'default') return null;
+	if (replicaIdentity === 'full') return { type: 'full', index: null };
+	if (replicaIdentity === 'nothing') return { type: 'nothing', index: null };
+	return { type: 'index', index: replicaIdentity.usingIndex };
+};
+
 export const policyFrom = (policy: PgPolicy, dialect: PgDialect) => {
 	const mappedTo = !policy.to
 		? ['public']
@@ -307,6 +316,7 @@ export const fromDrizzleSchema = (
 			schema,
 			name: config.name,
 			isRlsEnabled,
+			replicaIdentity: replicaIdentityFrom(config.replicaIdentity),
 		} satisfies PostgresEntities['tables'];
 	});
 

drizzle-kit/src/dialects/postgres/duckdb-introspect.ts

@@ -182,6 +182,7 @@ export const fromDatabase = async (
 			schema: trimChar(table.schema, "'"),
 			name: table.name,
 			isRlsEnabled: false,
+			replicaIdentity: null,
 		});
 	}