Interface PruneOptions

Options for DBA.prune().

interface PruneOptions {
    appId: string;
    attributes?: boolean;
    connection: ProviderConfig;
    expire?: string;
    jobs?: boolean;
    streams?: boolean;
}

Properties

appId attributes? connection expire? jobs? streams?

Properties

appId

appId: string

The application identifier (Postgres schema name).

Optionalattributes

attributes?: boolean

If true, strips execution-artifact attributes (adata, hmark, jmark, status, other) from completed jobs (status = 0), retaining only jdata (workflow return data) and udata (user-searchable data).

Default

false

connection

connection: ProviderConfig

Postgres connection configuration. Uses the same format as all other HotMesh services.

Example

{
  class: Postgres,
  options: { connectionString: 'postgresql://usr:pwd@localhost:5432/db' }
}

Optionalexpire

expire?: string

Retention period for expired rows. Rows with expired_at older than this interval are hard-deleted. Uses Postgres interval syntax.

Default

'7 days'

Example

'7 days', '24 hours', '30 minutes'

Optionaljobs

jobs?: boolean

If true, hard-deletes expired jobs older than the retention window. FK CASCADE on jobs_attributes automatically removes associated attribute rows.

Default

true

Optionalstreams

streams?: boolean

If true, hard-deletes expired stream messages older than the retention window.

Default

true

Settings

Member Visibility

On This Page

Properties