Interface ExplainGeoParquetQueryOptions<T>Experimental

Opt-in GeoParquet v2 planning options.

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

Type Parameters

  • T = Record<string, unknown>

Hierarchy (view full)

Properties

authorizationScope?: readonly string[]

Stable scope identifiers only. Never pass credentials or tokens.

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

capabilityPolicy?: CapabilityPolicy

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

effectiveSchema?: readonly GeoParquetEffectiveSchemaFieldV1[]

Trustworthy effective DuckDB output schema for this resource, established out-of-band by the trusted plan author (#627). Required to bind a plan that a resultEncoding: "lossless-json" source can execute opaquely.

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

executionMode?: QueryPlanExecutionMode

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

geoparquetResource: GeoParquetResourceHandleV1

Opaque stable identity; the locator remains private to the injected resolver.

query?: Readonly<Query<T>>

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