durable-execution-storage-drizzle
Version:
Drizzle ORM storage implementation for durable-execution
807 lines • 28.9 kB
TypeScript
import { type TablesRelationalConfig } from 'drizzle-orm';
import { type PgDatabase, type PgQueryResultHKT } from 'drizzle-orm/pg-core';
import { type DurableExecutionErrorStorageValue, type TaskExecutionCloseStatus, type TaskExecutionOnChildrenFinishedProcessingStatus, type TaskExecutionsStorage, type TaskExecutionStatus, type TaskExecutionSummary, type TaskRetryOptions } from 'durable-execution';
/**
* Creates a PostgreSQL table schema for storing durable task executions.
*
* This function generates a Drizzle ORM table definition with all necessary columns and indexes
* for the durable-execution storage layer. The table includes:
* - Task hierarchy tracking (root, parent, child relationships)
* - Execution state management (status, retries, timeouts)
* - Input/output data storage
* - Timestamp tracking for scheduling and expiration
*
* @example
* ```ts
* // In your schema file (e.g., schema.ts)
* import { createPgTaskExecutionsTable } from 'durable-execution-storage-drizzle'
*
* // Use default table name
* export const taskExecutions = createPgTaskExecutionsTable()
*
* // Or specify a custom table name
* export const myTasksTable = createPgTaskExecutionsTable('my_custom_task_executions')
* ```
*
* @param tableName - The name of the table to create. Defaults to 'task_executions'.
* @returns A Drizzle PostgreSQL table definition ready for migrations.
*/
export declare function createPgTaskExecutionsTable(tableName?: string): import("drizzle-orm/pg-core").PgTableWithColumns<{
name: string;
schema: undefined;
columns: {
id: import("drizzle-orm/pg-core").PgColumn<{
name: "id";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: true;
isPrimaryKey: true;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: "always";
generated: undefined;
}, {}, {}>;
rootTaskId: import("drizzle-orm/pg-core").PgColumn<{
name: "root_task_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
rootExecutionId: import("drizzle-orm/pg-core").PgColumn<{
name: "root_execution_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
parentTaskId: import("drizzle-orm/pg-core").PgColumn<{
name: "parent_task_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
parentExecutionId: import("drizzle-orm/pg-core").PgColumn<{
name: "parent_execution_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
indexInParentChildren: import("drizzle-orm/pg-core").PgColumn<{
name: "index_in_parent_children";
tableName: string;
dataType: "number";
columnType: "PgInteger";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
isOnlyChildOfParent: import("drizzle-orm/pg-core").PgColumn<{
name: "is_only_child_of_parent";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
isFinalizeOfParent: import("drizzle-orm/pg-core").PgColumn<{
name: "is_finalize_of_parent";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
taskId: import("drizzle-orm/pg-core").PgColumn<{
name: "task_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
executionId: import("drizzle-orm/pg-core").PgColumn<{
name: "execution_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
retryOptions: import("drizzle-orm/pg-core").PgColumn<{
name: "retry_options";
tableName: string;
dataType: "json";
columnType: "PgJson";
data: TaskRetryOptions;
driverParam: unknown;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskRetryOptions;
}>;
sleepMsBeforeRun: import("drizzle-orm/pg-core").PgColumn<{
name: "sleep_ms_before_run";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
timeoutMs: import("drizzle-orm/pg-core").PgColumn<{
name: "timeout_ms";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
areChildrenSequential: import("drizzle-orm/pg-core").PgColumn<{
name: "are_children_sequential";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
input: import("drizzle-orm/pg-core").PgColumn<{
name: "input";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
executorId: import("drizzle-orm/pg-core").PgColumn<{
name: "executor_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
isSleepingTask: import("drizzle-orm/pg-core").PgColumn<{
name: "is_sleeping_task";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
sleepingTaskUniqueId: import("drizzle-orm/pg-core").PgColumn<{
name: "sleeping_task_unique_id";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
status: import("drizzle-orm/pg-core").PgColumn<{
name: "status";
tableName: string;
dataType: "string";
columnType: "PgText";
data: TaskExecutionStatus;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskExecutionStatus;
}>;
isFinished: import("drizzle-orm/pg-core").PgColumn<{
name: "is_finished";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
runOutput: import("drizzle-orm/pg-core").PgColumn<{
name: "run_output";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
output: import("drizzle-orm/pg-core").PgColumn<{
name: "output";
tableName: string;
dataType: "string";
columnType: "PgText";
data: string;
driverParam: string;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
error: import("drizzle-orm/pg-core").PgColumn<{
name: "error";
tableName: string;
dataType: "json";
columnType: "PgJson";
data: DurableExecutionErrorStorageValue;
driverParam: unknown;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: DurableExecutionErrorStorageValue;
}>;
retryAttempts: import("drizzle-orm/pg-core").PgColumn<{
name: "retry_attempts";
tableName: string;
dataType: "number";
columnType: "PgInteger";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
startAt: import("drizzle-orm/pg-core").PgColumn<{
name: "start_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
startedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "started_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
expiresAt: import("drizzle-orm/pg-core").PgColumn<{
name: "expires_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
waitingForChildrenStartedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "waiting_for_children_started_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
waitingForFinalizeStartedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "waiting_for_finalize_started_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
finishedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "finished_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
children: import("drizzle-orm/pg-core").PgColumn<{
name: "children";
tableName: string;
dataType: "json";
columnType: "PgJson";
data: TaskExecutionSummary[];
driverParam: unknown;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskExecutionSummary[];
}>;
activeChildrenCount: import("drizzle-orm/pg-core").PgColumn<{
name: "active_children_count";
tableName: string;
dataType: "number";
columnType: "PgInteger";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
onChildrenFinishedProcessingStatus: import("drizzle-orm/pg-core").PgColumn<{
name: "on_children_finished_processing_status";
tableName: string;
dataType: "string";
columnType: "PgText";
data: TaskExecutionOnChildrenFinishedProcessingStatus;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskExecutionOnChildrenFinishedProcessingStatus;
}>;
onChildrenFinishedProcessingExpiresAt: import("drizzle-orm/pg-core").PgColumn<{
name: "on_children_finished_processing_expires_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
onChildrenFinishedProcessingFinishedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "on_children_finished_processing_finished_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
finalize: import("drizzle-orm/pg-core").PgColumn<{
name: "finalize";
tableName: string;
dataType: "json";
columnType: "PgJson";
data: TaskExecutionSummary;
driverParam: unknown;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskExecutionSummary;
}>;
closeStatus: import("drizzle-orm/pg-core").PgColumn<{
name: "close_status";
tableName: string;
dataType: "string";
columnType: "PgText";
data: TaskExecutionCloseStatus;
driverParam: string;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: [string, ...string[]];
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {
$type: TaskExecutionCloseStatus;
}>;
closeExpiresAt: import("drizzle-orm/pg-core").PgColumn<{
name: "close_expires_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
closedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "closed_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: false;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
needsPromiseCancellation: import("drizzle-orm/pg-core").PgColumn<{
name: "needs_promise_cancellation";
tableName: string;
dataType: "boolean";
columnType: "PgBoolean";
data: boolean;
driverParam: boolean;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
createdAt: import("drizzle-orm/pg-core").PgColumn<{
name: "created_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
updatedAt: import("drizzle-orm/pg-core").PgColumn<{
name: "updated_at";
tableName: string;
dataType: "number";
columnType: "PgBigInt53";
data: number;
driverParam: string | number;
notNull: true;
hasDefault: false;
isPrimaryKey: false;
isAutoincrement: false;
hasRuntimeDefault: false;
enumValues: undefined;
baseColumn: never;
identity: undefined;
generated: undefined;
}, {}, {}>;
};
dialect: "pg";
}>;
/**
* Type representing the PostgreSQL table schema for task executions. Use this type when you need
* to reference the table structure in your code.
*/
export type TaskExecutionsPgTable = ReturnType<typeof createPgTaskExecutionsTable>;
/**
* Creates a PostgreSQL storage adapter for durable-execution.
*
* This function creates a storage implementation that uses PostgreSQL as the backend for
* persisting task execution state. The storage adapter handles:
* - Transactional operations for consistency
* - Optimistic locking with 'FOR UPDATE SKIP LOCKED' for concurrent access
* - Efficient querying with proper indexes
* - Parent-child task relationship management
*
* @example
* ```ts
* import { drizzle } from 'drizzle-orm/node-postgres'
* import { Pool } from 'pg'
* import { DurableExecutor } from 'durable-execution'
* import { createPgTaskExecutionsTable, createPgTaskExecutionsStorage } from 'durable-execution-storage-drizzle'
*
* // Setup database connection
* const pool = new Pool({ connectionString: process.env.DATABASE_URL })
* const db = drizzle(pool)
*
* // Create table schema and storage
* const taskExecutionsTable = createPgTaskExecutionsTable()
* const storage = createPgTaskExecutionsStorage(db, taskExecutionsTable)
*
* // Use with DurableExecutor
* const executor = await DurableExecutor.make(storage)
* ```
*
* @param db - A Drizzle PostgreSQL database instance.
* @param taskExecutionsTable - The table created by `createPgTaskExecutionsTable()`.
* @param options - The options for the storage.
* @param options.enableTestMode - Whether to enable test mode. Defaults to false.
* @returns A TaskExecutionsStorage implementation for use with DurableExecutor.
*/
export declare function createPgTaskExecutionsStorage<TQueryResult extends PgQueryResultHKT, TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig>(db: PgDatabase<TQueryResult, TFullSchema, TSchema>, taskExecutionsTable: TaskExecutionsPgTable, options?: {
enableTestMode?: boolean;
}): TaskExecutionsStorage;
//# sourceMappingURL=pg.d.ts.map