Options for handle.exportExecution(). Controls event filtering, enrichment, and traversal depth for child workflows.

interface ExecutionExportOptions {
    allow_direct_query?: boolean;
    enrich_inputs?: boolean;
    exclude_system?: boolean;
    include_lineage?: boolean;
    include_stream_history?: boolean;
    max_depth?: number;
    mode?: ExportMode;
    omit_results?: boolean;
}

Properties

allow_direct_query?: boolean

When true, allows fallback to direct database queries for expired jobs whose in-memory handles have been pruned. Only supported with providers that implement the extended exporter query interface (e.g., Postgres).

false
enrich_inputs?: boolean

When true, enriches activity and child workflow events with their inputs by querying the underlying job attributes. This enables full visibility into activity arguments without requiring separate callback queries.

false (late-binding: only return timeline_key references)
exclude_system?: boolean

When true, omits internal/interceptor activities (names starting with lt) from the event list. Useful for user-facing dashboards.

false
include_lineage?: boolean

When true, populates the export's parent_workflow_id and origin_id from the jobs table via a single indexed lookup. parent_workflow_id is the real spawning workflow (never the synthetic collator $C job); origin_id is the root ancestor (a null parent_workflow_id marks a root). Opt-in so the extra query is only paid when a UI needs upward lineage. Requires a provider that implements getJobLineage (e.g., Postgres); a no-op otherwise.

false
include_stream_history?: boolean

When true, fetches the full stream message history for this workflow from the worker_streams table and attaches it as stream_history. This provides raw activity input/output data from the original stream messages, enabling full export fidelity.

false
max_depth?: number

Maximum recursion depth for verbose mode child workflow fetching.

5
mode?: ExportMode

sparse (default) — single-query export from the workflow's timeline markers. verbose — recursively fetches child workflow jobs and attaches their full event histories as nested children arrays.

omit_results?: boolean

When true, strips result and input payloads from event attributes. Reduces response size while preserving event structure and timing.

false