Interface CreateGeoArrowAggregateOperationOptionsExperimental

Options for the bounded GeoArrow aggregation worker operation.

interface CreateGeoArrowAggregateOperationOptions {
    group: GeoArrowAggregateGroupSpec;
    groupField?: string;
    id: string;
    limits?: GeoArrowConversionLimits;
    maxGroups?: number;
    metrics: readonly GeoArrowAggregateMetricSpec[];
    nullKeys?: GeoArrowAggregateNullKeyPolicy;
    schemaId: string;
    yieldIntervalRows?: number;
}

Properties

group groupField? id limits? maxGroups? metrics nullKeys? schemaId yieldIntervalRows?

Properties

Readonly Experimentalgroup

group: GeoArrowAggregateGroupSpec

Optional Readonly ExperimentalgroupField

groupField?: string

Output group field name. Grid grouping emits <name>_x and <name>_y.

Readonly Experimentalid

id: string

Stable id assigned to the aggregated output batch.

Optional Readonly Experimentallimits

limits?: GeoArrowConversionLimits

Conversion ceilings applied to the input inspection and the output batch.

Optional Readonly ExperimentalmaxGroups

maxGroups?: number

Ceiling on distinct groups. Defaults to DEFAULT_GEOARROW_AGGREGATE_MAX_GROUPS.

Readonly Experimentalmetrics

metrics: readonly GeoArrowAggregateMetricSpec[]

Optional Readonly ExperimentalnullKeys

nullKeys?: GeoArrowAggregateNullKeyPolicy

Null-key policy. Defaults to "null-group".

Readonly ExperimentalschemaId

schemaId: string

Schema id for the aggregated field set. It is also written as the result identity.schemaVersion, so it must change whenever the group or metric specification changes.

Optional Readonly ExperimentalyieldIntervalRows

yieldIntervalRows?: number

Rows scanned between cooperative event-loop yields.

Settings

Member Visibility

On This Page

Properties