Interface CubeDataSpaceEditor

The host's data space editor, e.g. Legend Analytics', from its query builder

interface CubeDataSpaceEditor {
    describeDataSpace(
        project: CubeProjectCoordinates,
        dataSpace: string,
    ): Promise<CubeDataSpaceDescription>;
    listDataSpaces(): Promise<readonly CubeDataSpaceSummary[]>;
    openSession(target: CubeDataSpaceEditorTarget): CubeDataSpaceEditorSession;
    renderSession(session: CubeDataSpaceEditorSession): ReactNode;
}

Index

Methods

describeDataSpace listDataSpaces openSession renderSession

Methods

describeDataSpace

describeDataSpace(
project: CubeProjectCoordinates,
dataSpace: string,
): Promise<CubeDataSpaceDescription>
A data space at a version of its project, with its execution contexts
Parameters
- project: CubeProjectCoordinates
- dataSpace: string
Returns Promise<CubeDataSpaceDescription>
- Defined in packages/legend-cube-builder/src/stores/CubeDataSpaceEditor.ts:108

listDataSpaces

listDataSpaces(): Promise<readonly CubeDataSpaceSummary[]>
The released data spaces in the host's depot

Returns Promise<readonly CubeDataSpaceSummary[]>
- Defined in packages/legend-cube-builder/src/stores/CubeDataSpaceEditor.ts:106

openSession

openSession(target: CubeDataSpaceEditorTarget): CubeDataSpaceEditorSession
Opens the query builder on a data space; the session loads its model
Parameters
- target: CubeDataSpaceEditorTarget
Returns CubeDataSpaceEditorSession
- Defined in packages/legend-cube-builder/src/stores/CubeDataSpaceEditor.ts:113

renderSession

renderSession(session: CubeDataSpaceEditorSession): ReactNode
The session's query builder, which fills the space it is given
Parameters
- session: CubeDataSpaceEditorSession
Returns ReactNode
- Defined in packages/legend-cube-builder/src/stores/CubeDataSpaceEditor.ts:115