Class QueryBuilder

Fluent builder for constructing QueryFeaturesRequest objects.

Create via QueryBuilder.from(serviceId, layerId) (standalone) or QueryBuilder.for(client, serviceId, layerId) (bound to a client for .run()).

Example

// Standalone — build request object
const req = QueryBuilder.from("myService", 0)
  .where("POP > 1000")
  .outFields("NAME", "POP")
  .limit(100)
  .build();

const result = await client.queryFeatures(req);

// Bound — build and execute in one chain
const result = await QueryBuilder.for(client, "myService", 0)
  .where("POP > 1000")
  .outFields("NAME", "POP")
  .limit(100)
  .run();

Index

Methods

build distinct extraParams geometry geometryType groupBy limit method objectIds offset orderBy outFields outStatistics returnCentroid returnGeometry run signal spatialRel where for from

Methods

build

build(): QueryFeaturesRequest
Build the QueryFeaturesRequest object without executing it.

Returns QueryFeaturesRequest
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:180

distinct

distinct(value?): this
Return only distinct values.
Parameters
- value: boolean = true
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:138

extraParams

extraParams(params): this
Set extra query parameters.
Parameters
- params: Record<string, string | number | boolean>
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:174

geometry

geometry(geom): this
Set a geometry filter. Accepts a geometry object or JSON string.
Parameters
- geom: string | Record<string, unknown>
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:90

geometryType

geometryType(type): this
Set the geometry type for the geometry filter.
Parameters
- type: EsriGeometryType
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:96

groupBy

groupBy(fields): this
Set group-by fields for statistics queries.
Parameters
- fields: string
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:150

limit

limit(count): this
Set the maximum number of features to return.
Parameters
- count: number
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:120

method

method(m): this
Set the HTTP method (GET or POST).
Parameters
- m: QueryMethod
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:162

objectIds

objectIds(ids): this
Filter by specific object IDs.
Parameters
- ids: string | number[]
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:132

offset

offset(count): this
Set the number of features to skip (for pagination).
Parameters
- count: number
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:126

orderBy

orderBy(fields): this
Set the fields to order results by (e.g. "NAME ASC").
Parameters
- fields: string
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:114

outFields

outFields(...fieldNames): this
Set the output fields to return. Accepts individual field names.
Parameters
- Rest...fieldNames: string[]
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:84

outStatistics

outStatistics(stats): this
Set output statistics definitions.
Parameters
- stats: string | readonly Record<string, unknown>[]
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:156

returnCentroid

returnCentroid(value?): this
Return centroids instead of full geometries.
Parameters
- value: boolean = true
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:144

returnGeometry

returnGeometry(value): this
Whether to include geometry in the response.
Parameters
- value: boolean
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:108

run

run(): Promise<HonuaQueryResponse>
Build the request and execute it via the bound client. Throws if the builder was created with QueryBuilder.from() (no client).

Returns Promise<HonuaQueryResponse>
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:211

signal

signal(s): this
Attach an AbortSignal for cancellation.
Parameters
- s: AbortSignal
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:168

spatialRel

spatialRel(rel): this
Set the spatial relationship for the geometry filter.
Parameters
- rel: EsriSpatialRel
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:102

where

where(clause): this
Set the WHERE clause for filtering features.
Parameters
- clause: string
Returns this
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:78

`Static`for

for(client, serviceId, layerId): QueryBuilder
Create a builder bound to a client (enables .run() to execute the query).
Parameters
- client: HonuaClient
- serviceId: string
- layerId: number
Returns QueryBuilder
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:73

`Static`from

from(serviceId, layerId): QueryBuilder
Create a standalone builder (call .build() to get the request object).
Parameters
- serviceId: string
- layerId: number
Returns QueryBuilder
- Defined in work/honua-sdk-js/honua-sdk-js/src/core/query-builder.ts:68

Class QueryBuilder

Example

Index

Methods

Methods

build

Returns QueryFeaturesRequest

distinct

Parameters

Returns this

extraParams

Parameters

Returns this

geometry

Parameters

Returns this

geometryType

Parameters

Returns this

groupBy

Parameters

Returns this

limit

Parameters

Returns this

method

Parameters

Returns this

objectIds

Parameters

Returns this

offset

Parameters

Returns this

orderBy

Parameters

Returns this

outFields

Parameters

Returns this

outStatistics

Parameters

Returns this

returnCentroid

Parameters

Returns this

returnGeometry

Parameters

Returns this

run

Returns Promise<HonuaQueryResponse>

signal

Parameters

Returns this

spatialRel

Parameters

Returns this

where

Parameters

Returns this

Staticfor

Parameters

Returns QueryBuilder

Staticfrom

Parameters

Returns QueryBuilder

Settings

On This Page

`Static`for

`Static`from