Interface OgcRecordsRawSearchRequest

Raw response access for record searches.

interface OgcRecordsRawSearchRequest {
    accept?: string;
    basePath?: string;
    bbox?: string | readonly [number, number, number, number];
    cache?: HonuaCacheReadMode;
    collectionId: string | number;
    datetime?: string;
    externalIds?: string | readonly string[];
    extraParams?: Record<string, string | number | boolean>;
    filter?: string;
    filterCrs?: string;
    filterLang?: string & {} | "cql2-text" | "cql2-json";
    headers?: HeadersInit;
    ids?: string | readonly (string | number)[];
    layout?: OgcEndpointLayout;
    limit?: number;
    offset?: number;
    profile?: string | readonly string[];
    properties?: string | readonly string[];
    q?: string | readonly string[];
    refresh?: boolean;
    responseFormat?: string;
    signal?: AbortSignal;
    sortby?: string;
    stacBasePath?: string;
    staleIfError?: boolean;
    staleIfErrorMs?: number;
    ttlMs?: number;
    type?: string | readonly string[];
}

Hierarchy (view full)

Properties

accept? basePath? bbox? cache? collectionId datetime? externalIds? extraParams? filter? filterCrs? filterLang? headers? ids? layout? limit? offset? profile? properties? q? refresh? responseFormat? signal? sortby? stacBasePath? staleIfError? staleIfErrorMs? ttlMs? type?

Properties

Optionalaccept

accept?: string

OptionalbasePath

basePath?: string

Raw endpoint path prefix for the OGC API Tiles / Maps / Records / Processes families (the ones that do not use layout). Defaults to the family's Honua facade prefix (/ogc/tiles, /ogc/maps, /ogc/records, /ogc/processes). A raw third-party endpoint mounted at a different root (discovered by connect()) passes its service-root path here so every request resolves against the advertised layout. Ignored by OGC API Features (which uses layout) and STAC (which uses stacBasePath).

Optionalbbox

bbox?: string | readonly [number, number, number, number]

Optional Readonlycache

cache?: HonuaCacheReadMode

default reads and writes the adapter metadata cache. bypass skips cache lookup and write-through for endpoints that support SDK-local caching.

collectionId

collectionId: string | number

Optionaldatetime

datetime?: string

OptionalexternalIds

externalIds?: string | readonly string[]

External resource identifiers associated with the record.

OptionalextraParams

extraParams?: Record<string, string | number | boolean>

Optionalfilter

filter?: string

Optional CQL2 filter when the server advertises the Records filtering class.

OptionalfilterCrs

filterCrs?: string

OptionalfilterLang

filterLang?: string & {} | "cql2-text" | "cql2-json"

Optionalheaders

headers?: HeadersInit

Optionalids

ids?: string | readonly (string | number)[]

Optionallayout

layout?: OgcEndpointLayout

Resolved endpoint layout. Omitted requests use the Honua facade fast path (/ogc/features/...); the backend-agnostic surfaces resolve a spec-driven layout once and thread it onto every request.

Optionallimit

limit?: number

Optionaloffset

offset?: number

Optionalprofile

profile?: string | readonly string[]

Optionalproperties

properties?: string | readonly string[]

Optionalq

q?: string | readonly string[]

Free-text record search terms. Arrays serialize as OGC form-style CSV.

Optional Readonlyrefresh

refresh?: boolean

Revalidate even when an SDK-local metadata entry is present. Adapters send conditional validators when available and report refreshed on success.

OptionalresponseFormat

responseFormat?: string

Optionalsignal

signal?: AbortSignal

Optionalsortby

sortby?: string

OptionalstacBasePath

stacBasePath?: string

STAC-only: path prefix the STAC endpoints are mounted under. Defaults to /stac (Honua facade). A raw STAC API root passes "". Ignored by the OGC API Features methods (which use layout).

Optional ReadonlystaleIfError

staleIfError?: boolean

Allow a cached metadata entry to be returned as stale when refresh fails. Defaults to true; ignored when no cached metadata entry exists.

Optional ReadonlystaleIfErrorMs

staleIfErrorMs?: number

Optional stale fallback window surfaced to callers in HonuaCacheState.

Optional ReadonlyttlMs

ttlMs?: number

Optional freshness budget surfaced to callers in HonuaCacheState.

Optionaltype

type?: string | readonly string[]

Record resource type filter, e.g. dataset, service, map, collection.

Settings

Member Visibility

On This Page

Properties