IExecutionResult

Home > @gooddata/sdk-backend-spi > IExecutionResult

IExecutionResult interface

Represents results of execution done with particular definition.

Signature:

export interface IExecutionResult 

Remarks

Within the result is the description of the shape of the data and methods to to obtain views on the data.

Properties

Property	Modifiers	Type	Description
definition	readonly	IExecutionDefinition	Full definition of execution that yielded this result.
dimensions	readonly	IDimensionDescriptor[]	Description of shape of the data.
signal?	readonly	AbortSignal	(Optional) Abort signal to cancel the result retrieval. Note that the abort signal is shared with the prepared execution that created this result, so if you cancel the result and want to retrieve it later again, you should always create also a new execution for it.

Methods

Method	Description
equals(other)	Tests if this execution result is same as the other result.
export(options)	Asynchronously exports all data in this result to a blob. Exported file is downloaded and attached as Blob data to the current window instance.
fingerprint()	Unique fingerprint of the execution result.
readAll()	Asynchronously reads all data for this result into a single data view.
readAnomalyDetectionAll(config)	(ALPHA) Reads anomaly detection for the execution result.
readClusteringAll(config)	(ALPHA) Reads anomaly detection for the execution result.
readForecastAll(config)	(BETA) Reads forecast for the execution result.
readWindow(offset, size)	Asynchronously reads a window of data for this result.
transform()	Transforms this execution result - changing the result sorting, dimensionality and available totals is possible through transformation.