Interface ExplainOptions

Planning controls for the connection-owned, feature-result query workflow.

interface ExplainOptions {
    cache?: QueryPlanCacheOptions;
    capabilityPolicy?: CapabilityPolicy;
    estimates?: QueryPlanningEstimates;
    fallback?: QueryFallbackPolicy;
    refresh?: boolean;
    signal?: AbortSignal;
    sourceId?: string;
}

Index

Properties

cache? capabilityPolicy? estimates? fallback? refresh? signal? sourceId?

Properties

`Optional` `Readonly`cache

cache?: QueryPlanCacheOptions

Explicit query-result cache observation; discovery metadata cache state is never inferred here.

`Optional` `Readonly`capabilityPolicy

capabilityPolicy?: CapabilityPolicy

`Optional` `Readonly`estimates

estimates?: QueryPlanningEstimates

`Optional` `Readonly`fallback

fallback?: QueryFallbackPolicy

`Optional` `Readonly`refresh

refresh?: boolean

Refresh discovery before planning. The resulting observation is bound into the plan.

`Optional` `Readonly`signal

signal?: AbortSignal

`Optional` `Readonly`sourceId

sourceId?: string

Select a source explicitly when the connection advertises more than one.