Interface ExplainQueryOptions<T>

interface ExplainQueryOptions<T> {
    authorizationScope?: readonly string[];
    cache?: QueryPlanCacheOptions;
    capabilityPolicy?: CapabilityPolicy;
    descriptor: SourceDescriptor<Protocol>;
    discovery?: QueryPlanDiscoveryContext;
    estimates?: QueryPlanningEstimates;
    executionMode?: QueryPlanExecutionMode;
    fallback?: QueryFallbackPolicy;
    query?: Readonly<Query<T>>;
    representation?: QueryPlanRepresentationRequest;
    schemaVersion?: string;
    sourceVersion?: string;
}

Type Parameters

  • T = Record<string, unknown>

Hierarchy (view full)

Properties

authorizationScope? cache? capabilityPolicy? descriptor discovery? estimates? executionMode? fallback? query? representation? schemaVersion? sourceVersion?

Properties

Optional ReadonlyauthorizationScope

authorizationScope?: readonly string[]

Stable scope identifiers only. Never pass credentials or tokens.

Optional Readonlycache

cache?: QueryPlanCacheOptions

Stable cache state only. Observation clocks never enter a plan fingerprint.

Optional ReadonlycapabilityPolicy

capabilityPolicy?: CapabilityPolicy

Readonlydescriptor

descriptor: SourceDescriptor<Protocol>

Optional Readonlydiscovery

discovery?: QueryPlanDiscoveryContext

Credential-safe discovery identity. Raw sources/validators are digested.

Optional Readonlyestimates

estimates?: QueryPlanningEstimates

Caller-supplied metadata estimates; explaining never reads result data.

Optional ReadonlyexecutionMode

executionMode?: QueryPlanExecutionMode

Realtime delta plans carry mode only; live cursor bytes remain transport state.

Optional Readonlyfallback

fallback?: QueryFallbackPolicy

Optional Readonlyquery

query?: Readonly<Query<T>>

Optional Readonlyrepresentation

representation?: QueryPlanRepresentationRequest

Result-representation intent. Defaults to auto, which selects from declared source capabilities plus ExplainQueryOptions.estimates. Pinning a representation the source cannot serve throws HonuaCapabilityNotSupportedError rather than degrading silently.

Optional ReadonlyschemaVersion

schemaVersion?: string

Optional ReadonlysourceVersion

sourceVersion?: string

Settings

Member Visibility

On This Page

Properties