Interface CubeConnectionExplorer

Reading a direct connection's database (PLAN §6.8), for the picker: its own port, beside the CubeEngine, so hosts without direct connections need neither. Calls fail with a CubeEngineError, with no node

interface CubeConnectionExplorer {
    buildConnection(draft: CubeConnectionDraft): PlainObject;
    describeConnection(connection: PlainObject): CubeConnectionDescription;
    listSchemas(connection: PlainObject): Promise<readonly string[]>;
    listTables(
        connection: PlainObject,
        schema: string,
    ): Promise<readonly CubeExploredTable[]>;
}

Index

Methods

buildConnection describeConnection listSchemas listTables

Methods

buildConnection

buildConnection(draft: CubeConnectionDraft): PlainObject
The connection the connection form describes
Parameters
- draft: CubeConnectionDraft
Returns PlainObject
- Defined in packages/legend-cube-builder/src/graph-manager/CubeConnectionExplorer.ts:91

describeConnection

describeConnection(connection: PlainObject): CubeConnectionDescription
Whether Cube can use a connection, and what the page shows of it: no engine call
Parameters
- connection: PlainObject
Returns CubeConnectionDescription
- Defined in packages/legend-cube-builder/src/graph-manager/CubeConnectionExplorer.ts:94

listSchemas

listSchemas(connection: PlainObject): Promise<readonly string[]>
The schemas of the connection's database, without the database's own; tests the connection
Parameters
- connection: PlainObject
Returns Promise<readonly string[]>
- Defined in packages/legend-cube-builder/src/graph-manager/CubeConnectionExplorer.ts:99

listTables

listTables(
connection: PlainObject,
schema: string,
): Promise<readonly CubeExploredTable[]>
A schema's tables and views, with how many columns Cube can use and hides
Parameters
- connection: PlainObject
- schema: string
Returns Promise<readonly CubeExploredTable[]>
- Defined in packages/legend-cube-builder/src/graph-manager/CubeConnectionExplorer.ts:102

Interface CubeConnectionExplorer

Index

Methods

Methods

buildConnection

Parameters

Returns PlainObject

describeConnection

Parameters

Returns CubeConnectionDescription

listSchemas

Parameters

Returns Promise<readonly string[]>

listTables

Parameters

Returns Promise<readonly CubeExploredTable[]>

Settings

On This Page