Interface ExplainQueryOptions<T>

interface ExplainQueryOptions<T> {
    authorizationScope?: readonly string[];
    capabilityPolicy?: CapabilityPolicy;
    descriptor: SourceDescriptor;
    estimates?: QueryPlanningEstimates;
    fallback?: QueryFallbackPolicy;
    query?: Readonly<Query<T>>;
    schemaVersion?: string;
    sourceVersion?: string;
}

Type Parameters

T = Record<string, unknown>

Hierarchy (view full)

ExplainQueryOptions
- ExplainGeoParquetQueryOptions

Index

Properties

authorizationScope? capabilityPolicy? descriptor estimates? fallback? query? schemaVersion? sourceVersion?

Properties

`Optional` `Readonly`authorizationScope

authorizationScope?: readonly string[]

Stable scope identifiers only. Never pass credentials or tokens.

`Optional` `Readonly`capabilityPolicy

capabilityPolicy?: CapabilityPolicy

`Readonly`descriptor

descriptor: SourceDescriptor

`Optional` `Readonly`estimates

estimates?: QueryPlanningEstimates

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

`Optional` `Readonly`fallback

fallback?: QueryFallbackPolicy

`Optional` `Readonly`query

query?: Readonly<Query<T>>

`Optional` `Readonly`schemaVersion

schemaVersion?: string

`Optional` `Readonly`sourceVersion

sourceVersion?: string