RawExecute

The RawExecute component runs an execution that you have already prepared (IPreparedExecution) and passes the loading state, error, and data view to its children render function. Build the prepared execution yourself, for example with backend.workspace(workspace).execution().forItems([...]); to run a saved visualization, use ExecuteInsight instead.

Basic usage

import { RawExecute, useBackendStrict, useWorkspaceStrict } from "@gooddata/sdk-ui";
import * as Md from "./catalog.js";

export const Example = () => {
    const backend = useBackendStrict();
    const workspace = useWorkspaceStrict();
    const execution = backend.workspace(workspace).execution().forItems([Md.Amount, Md.Product.Name]);

    return (
        <RawExecute execution={execution}>
            {({ isLoading, error, result }) => {
                if (isLoading) {
                    return <div>Loading...</div>;
                }
                if (error) {
                    return <div>Error: {error.message}</div>;
                }
                return <pre>{JSON.stringify(result?.dataView.data, null, 2)}</pre>;
            }}
        </RawExecute>
    );
};

States

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

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

Rendering

RawExecute 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

• RawExecute starts a new execution when execution.fingerprint() changes. A prepared execution rebuilt with the same definition on every render does not start a new one.
• It also starts a new execution when window changes by deep comparison, or when onError, onLoadingChanged, onLoadingFinish, or onLoadingStart changes by reference. Memoize these callbacks.
• Calling reload() starts a new execution at any time.
• When a new execution starts before the running one finishes, the running one is canceled. The request itself keeps running unless enableExecutionCancelling is true; then its signal is aborted.

Notes

• Set loadOnMount={false} to skip the initial run, and call reload() to start it, for example after a user action.
• Without window, RawExecute reads all data. Pass window with offset and size arrays to read one page of a large result.
• exportTitle defaults to "RawExecute".

Props