@honua/sdk-js
    Preparing search index...

    Interface ExplainQueryOptions<T>

    interface ExplainQueryOptions<T = Record<string, unknown>> {
        authorizationScope?: readonly string[];
        cache?: QueryPlanCacheOptions;
        capabilityPolicy?: CapabilityPolicy;
        descriptor: SourceDescriptor;
        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 Summary)

    Index

    Properties

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

    Properties

    authorizationScope?: readonly string[]

    Stable scope identifiers only. Never pass credentials or tokens.

    cache?: QueryPlanCacheOptions

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

    capabilityPolicy?: CapabilityPolicy
    descriptor: SourceDescriptor
    discovery?: QueryPlanDiscoveryContext

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

    estimates?: QueryPlanningEstimates

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

    executionMode?: QueryPlanExecutionMode

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

    fallback?: QueryFallbackPolicy
    query?: Readonly<Query<T>>
    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.

    schemaVersion?: string
    sourceVersion?: string

    Settings

    Member Visibility

    On This Page

    Properties