rollup params Schema #
undefined#/properties/postProcess/items/allOf/17/properties/params
Parameters to be passed to the rollup 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 (rollup params)
rollup 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) |
| rollupTrigger | Flexible | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| rollupSummary | 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:
stringorarray(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:
stringorarray(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
rollupTrigger #
rollupTrigger TODO
rollupTrigger
- is optional
- type: any of the folllowing:
stringorarray(rollupTrigger) - cannot be null
- defined in: rollupTrigger
rollupSummary #
rollupSummary TODO
rollupSummary
- is optional
- type: any of the folllowing:
stringorarray(rollupSummary) - cannot be null
- defined in: rollupSummary
residual #
Enumeration of strings with constraints below
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