TypeORM

@dudousxd/nestjs-durable-store-typeorm persists runs and step checkpoints through TypeORM, on any dialect it supports — Postgres, MySQL/MariaDB, SQLite. It declares typeorm as a peer and rides the DataSource you already configure.

pnpm add @dudousxd/nestjs-durable-store-typeorm

1. Register the durable entities

The adapter uses dataSource.getRepository(...) for each durable table, so its entities must be registered on your DataSource. The package exports them as ENTITIES:

import { DataSource } from 'typeorm';
import { ENTITIES as DURABLE_ENTITIES } from '@dudousxd/nestjs-durable-store-typeorm';

export const dataSource = new DataSource({
  type: 'postgres',
  // …host, database, etc.
  entities: [...DURABLE_ENTITIES, /* your own entities */],
});

ENTITIES is the five durable_* entities the engine owns — WorkflowRunEntity, StepCheckpointEntity, RunAttributeEntity, SignalWaiterEntity, BufferedSignalEntity.

Column naming

ENTITIES uses the canonical snake_case columns. To read a table an older, unpinned setup wrote in camelCase, or to supply a custom mapping, build the schemas with durableEntities({ naming }) instead:

import { durableEntities } from '@dudousxd/nestjs-durable-store-typeorm';

export const dataSource = new DataSource({
  type: 'postgres',
  entities: [...durableEntities({ naming: 'snake_case' }), /* your own entities */],
});

naming accepts 'snake_case' (default), 'preserve' (the legacy camelCase this adapter used to produce), or (property: string) => string. Same contract as the MikroORM adapter's durableEntities — the physical column names must agree across adapters so a run written by one store stays readable by another.

2. Wire the store into the module

TypeOrmStateStore takes the DataSource:

import { DataSource } from 'typeorm';
import { TypeOrmStateStore } from '@dudousxd/nestjs-durable-store-typeorm';

DurableModule.forRootAsync({
  inject: [DataSource],
  useFactory: (ds: DataSource) => ({
    store: new TypeOrmStateStore(ds),
    transport,
  }),
});

Schema: auto on boot, or your own migration

With auto-schema on (the default), the module calls store.ensureSchema(), which runs the dialect-aware ensureTypeOrmDurableSchema(dataSource) — additive, never destructive. It quotes identifiers per driver, uses varchar(191) for keyed columns (MySQL can't index a text column) and longtext for the free-form JSON payloads on MySQL (its text caps at 64 KB and would silently truncate a large fan-out step's events).

To own the schema yourself, disable it and call the helper from a migration:

import { ensureTypeOrmDurableSchema } from '@dudousxd/nestjs-durable-store-typeorm';

export class AddDurableTables implements MigrationInterface {
  async up(q: QueryRunner) {
    await ensureTypeOrmDurableSchema(q.connection);
  }
}

DurableModule.forRoot({ store, transport, autoSchema: false });