group params Schema #

undefined#/properties/postProcess/items/allOf/16/properties/params

Parameters to be passed to the group module

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	specSchema.schema.json*

params Type #

object (group params)

group params Properties #

Property	Type	Required	Nullable	Defined by
identity	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
accumulate	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
accumulateToCap	`number`	Optional	cannot be null	specSchema (Unified Pipeline Specification)
row	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
rowEmit	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
groupTrigger	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
groupTriggerAccumulate	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
groupItem	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
groupItemEmit	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
groupSummary	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
drain	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
residual	Not specified	Optional	cannot be null	specSchema (Unified Pipeline Specification)
accumulatorStore	Not specified	Optional	cannot be null	specSchema (Unified Pipeline Specification)
data	Not specified	Optional	cannot be null	specSchema (Unified Pipeline Specification)

identity #

The field that identifies rows to be included in aggregation

identity

is optional
type: any of the folllowing: string or array (identity)
cannot be null
defined in: identity

accumulate #

A sequence of JSONata expressions to collect data available to the next processing cycle of this module

accumulate

is optional
type: any of the folllowing: string or array (accumulate)
cannot be null
defined in: accumulate

accumulateToCap #

The maximum capacity of the accumulator

accumulateToCap

is optional
type: number
cannot be null
Unstructured type

row #

A sequence of JSONata expressions to apply to each row

row

is optional
type: any of the folllowing: string or array (row)
cannot be null
defined in: row

rowEmit #

A sequence of JSONata expressions that writes the row to the next step in the pipeline

rowEmit

is optional
type: any of the folllowing: string or array (rowEmit)
cannot be null
defined in: rowEmit

groupTrigger #

groupTrigger TODO

groupTrigger

is optional
type: any of the folllowing: string or array (groupTrigger)
cannot be null
defined in: groupTrigger

groupTriggerAccumulate #

groupTriggerAccumulate TODO

groupTriggerAccumulate

is optional
type: any of the folllowing: string or array (groupTriggerAccumulate)
cannot be null
defined in: groupTriggerAccumulate

groupItem #

groupItem TODO

groupItem

is optional
type: any of the folllowing: string or array (groupItem)
cannot be null
defined in: groupItem

groupItemEmit #

groupItemEmit TODO

groupItemEmit

is optional
type: any of the folllowing: string or array (groupItemEmit)
cannot be null
defined in: groupItemEmit

groupSummary #

groupSummary TODO

groupSummary

is optional
type: any of the folllowing: string or array (groupSummary)
cannot be null
defined in: groupSummary

drain #

drain TODO

drain

is optional
type: any of the folllowing: string or array (drain)
cannot be null
defined in: drain

residual #

Enumeration of strings with constraints below

residual

is optional
type: unknown (residual)
cannot be null
defined in: residual

residual Constraints #

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"process"`
`"skip"`

accumulatorStore #

The storage medium for the accumulator

accumulatorStore

is optional
type: unknown (accumulatorStore)
cannot be null
defined in: accumulatorStore

accumulatorStore Constraints #

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"memory"`
`"leveldb"`

data #

Inline data to be processed by the JSONata expressions

data

is optional
type: unknown (data)
cannot be null
defined in: data