forBuckets()

Home > @gooddata/sdk-backend-spi > IExecutionFactory > forBuckets

IExecutionFactory.forBuckets() method

Prepares a new execution for a list of buckets.

Signature:

forBuckets(buckets: IBucket[], filters?: INullableFilter[], options?: IPreparedExecutionOptions): IPreparedExecution;

Parameters

Parameter	Type	Description
buckets	IBucket[]	list of buckets with attributes and measures, must be non empty, must have at least one attr or measure
filters	INullableFilter[]	(Optional) optional, may not be provided, may contain null or undefined values which must be ignored
options	IPreparedExecutionOptions	(Optional) additional options for the prepared execution

Returns:

IPreparedExecution

Remarks

Attributes and measures WILL be transferred to the execution in natural order:

• Order of items within a bucket is retained in the execution - Items from first bucket appear before items from second bucket

Or more specifically, given two buckets with items as [A1, A2, M1] and [A3, M2, M3], the resulting prepared execution WILL have definition with attributes = [A1, A2, A3] and measures = [M1, M2, M3]

The contract is that prepared executions created by this method MUST be executable and MUST come with pre-filled dimensions created using the defaultDimensionsGenerator().