Interface CanonicalQuery

Serializable form of the current canonical Query. AbortSignal is deliberately excluded: cancellation belongs to execution, never identity.

interface CanonicalQuery {
    aggregation?: AggregationSpec;
    orderBy?: readonly {
        direction: "asc" | "desc";
        field: string;
    }[];
    outFields?: readonly string[];
    outSr?: string | number;
    pagination?: {
        limit?: number;
        offset?: number;
    };
    returnGeometry?: boolean;
    spatialFilter?: CanonicalSpatialFilter;
    where?: {
        expression: string;
        kind: "source-native";
    };
}

Properties

aggregation? orderBy? outFields? outSr? pagination? returnGeometry? spatialFilter? where?

Properties

Optional Readonlyaggregation

aggregation?: AggregationSpec

Optional ReadonlyorderBy

orderBy?: readonly {
    direction: "asc" | "desc";
    field: string;
}[]

Optional ReadonlyoutFields

outFields?: readonly string[]

Optional ReadonlyoutSr

outSr?: string | number

Optional Readonlypagination

pagination?: {
    limit?: number;
    offset?: number;
}

Optional ReadonlyreturnGeometry

returnGeometry?: boolean

Optional ReadonlyspatialFilter

spatialFilter?: CanonicalSpatialFilter

Optional Readonlywhere

where?: {
    expression: string;
    kind: "source-native";
}

The current contract carries a source-native string escape hatch.

Settings

Member Visibility

On This Page

Properties