IPreparedExecution
Home > @gooddata/sdk-backend-spi > IPreparedExecution
IPreparedExecution interface
Prepared execution already knows what data to calculate and allows to specify how the data should be sorted and shaped into dimensions.
Signature:
export interface IPreparedExecution
Remarks
To this end, it provides several functions to customize sort items and dimensions. The prepared execution is immutable and so all the customization functions WILL result in a new instance of prepared execution.
The contract for creating these new instances is that the new prepared execution MUST be created using the execution factory that created current execution.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| definition | readonly | IExecutionDefinition | Definition of the execution accumulated to so far. |
Methods
| Method | Description |
|---|---|
| equals(other) | Tests whether this execution and the other execution are the same. |
| execute() | Starts the execution. |
| fingerprint() | Fingerprint of this prepared execution. |
| withDateFormat(dateFormat) | Adds the desired date format to the postProcessing of an IPreparedExecution. |
| withDimensions(dim) | Configures dimensions of the resulting data. Any dimension settings accumulated so far WILL be wiped out. |
| withExecConfig(config) | Additional execution configuration |
| withSorting(items) | Changes sorting of the resulting data. Any sorting settings accumulated so far WILL be wiped out. |