Execute

The Execute component builds an execution from measures and attributes, runs it, and passes the result to its children render function as data series (built from measures, optionally scoped by attribute elements) sliced by additional attributes. Either seriesBy or slicesBy must contain at least one item.

Basic usage

import { Execute } from "@gooddata/sdk-ui";
import * as Md from "./catalog.js";

export const Example = () => (
    <Execute
        seriesBy={[Md.Amount, Md.Won]}
        slicesBy={[Md.Product.Name]}
        filters={[]}
    >
        {({ result, error, isLoading }) => {
            if (isLoading) {
                return <div>Loading...</div>;
            }
            if (error) {
                return <div>Error: {error.message}</div>;
            }
            const data = result?.data();
            return <pre>{JSON.stringify(data?.series().toArray(), null, 2)}</pre>;
        }}
    </Execute>
);

States

The children function receives a WithLoadingResult in one of these states.

reload is available in every state and starts a new execution.

Rendering

Execute picks what to render in this order:

When you set both LoadingComponent and ErrorComponent, children is called only with a successful result.

When it re-runs

• Execute starts a new execution when any of seriesBy, slicesBy, totals, filters, sortBy, window, or workspace changes by deep comparison. Placeholders are resolved before the comparison, so a change of a placeholder value also triggers a new execution.
• It also starts a new execution when onError, onLoadingChanged, onLoadingFinish, or onLoadingStart changes by reference. If you pass inline functions, each render of the parent starts a new execution.
• Changing backend alone does not start a new execution.
• Calling reload() starts a new execution at any time.
• When a new execution starts or the component unmounts before the running one finishes, the running one is canceled and onError is called with a CancelledSdkError. The request itself keeps running unless enableExecutionCancelling is true; then its signal is aborted.

Notes

• backend and workspace props take precedence over BackendProvider and WorkspaceProvider. If neither is available, Execute does not throw during render: the load fails and the error is passed in error and to onError.
• If both seriesBy and slicesBy are empty, the load fails with an UnexpectedSdkError: “In the Execute component, either seriesBy or slicesBy must be defined and must contain at least one item”.
• seriesBy, slicesBy, totals, filters, and sortBy can contain placeholders. Pass placeholdersResolutionContext for composed placeholders.
• An empty result is not a NoDataError. Handle the zero-row case in children.
• After each load, onExportReady is called with an export function, or, after a failure, with a function that rejects with the error. exportTitle defaults to componentName, which defaults to "Execute".

Props