Kaizen
Browse modulesMigrationsFunctions

Function: taprootAuditForeignKeys()

function taprootAuditForeignKeys(targets: {
  organizations?: TaprootFkTarget;
  users: TaprootFkTarget;
}): Record<string, ForeignKeyOption>;

Defined in: server/migrations/index.ts:240

Build the foreignKeyOptions map that attaches every taproot audit and organization_id column to the consumer's own users / organizations tables. Pass the result under foreignKeys.taproot in taproot.config.*, or hand it to migrateTaprootTables as foreignKeyOptions.

Parameters

ParameterType
targets{ organizations?: TaprootFkTarget; users: TaprootFkTarget; }
targets.organizations?TaprootFkTarget
targets.usersTaprootFkTarget

Returns

Record<string, ForeignKeyOption>

Examples

taproot-provided auth

foreignKeys: { taproot: taprootAuditForeignKeys({
  users: { schema: "taproot", table: "user" },
  organizations: { schema: "taproot", table: "organization" },
}) }

roll-your-own auth (e.g. cuid ids)

foreignKeys: { taproot: taprootAuditForeignKeys({
  users: { schema: "public", table: "users", columnType: "TEXT" },
  organizations: { schema: "public", table: "organizations", columnType: "TEXT" },
}) }

On this page