Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
    AI Lake - Databases
    AI Lake - Pipe Tables
      (BETA) List AI Lake pipe tablesget(BETA) Create a new AI Lake pipe tablepost(BETA) Get an AI Lake pipe tableget(BETA) Delete an AI Lake pipe tabledelete
    AI Lake - Services & Operations
Other
Schemas
powered by Zudoku
OpenAPI definition

AI Lake - Pipe Tables

Endpoint:/

(BETA) List AI Lake pipe tables

GET
/api/v1/ailake/database/instances/{instanceId}/pipeTables

(BETA) Lists all active pipe tables in the given AI Lake database instance.

(BETA) List AI Lake pipe tables › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) List AI Lake pipe tables › Responses

AI Lake pipe tables successfully retrieved

  • pipeTablesobject[] · required

    Pipe tables in the requested database

GET /api/v1/ailake/database/instances/{instanceId}/pipeTables

(BETA) Create a new AI Lake pipe table

POST
/api/v1/ailake/database/instances/{instanceId}/pipeTables

(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.

(BETA) Create a new AI Lake pipe table › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

(BETA) Create a new AI Lake pipe table › Headers

  • operation-idstring

(BETA) Create a new AI Lake pipe table › Request Body

  • pathPrefixstring · required

    S3 path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.

  • sourceStorageNamestring · required

    Name of the pre-configured S3/MinIO ObjectStorage source

  • tableNamestring · required

    Name of the OLAP table to create. Must match ^[a-z][a-z0-9_]{0,62}$

  • columnOverridesobject

    Override inferred column types. Maps column names to SQL type strings (e.g. {"year": "INT", "event_date": "DATE"}). Applied after parquet schema inference.

  • distributionConfigobject

    Distribution configuration for the OLAP table.

  • keyConfigobject

    Key configuration for the table data model.

  • maxVarcharLengthinteger · int32

    Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.

  • partitionConfigobject

    Partition configuration for the table.

  • tablePropertiesobject

    CREATE TABLE PROPERTIES key-value pairs. Defaults to {"replication_num": "1"}.

(BETA) Create a new AI Lake pipe table › Responses

Accepted

POST /api/v1/ailake/database/instances/{instanceId}/pipeTables

(BETA) Get an AI Lake pipe table

GET
/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}

(BETA) Returns full details of the specified pipe table.

(BETA) Get an AI Lake pipe table › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

  • tableNamestring · required

    Pipe table name.

    Pipe table name.

(BETA) Get an AI Lake pipe table › Responses

AI Lake pipe table successfully retrieved

  • columnsobject[] · required

    Inferred column schema

  • databaseNamestring · required

    Database name

  • distributionConfigrequired
  • keyConfigrequired
  • partitionColumnsstring[] · required

    Hive partition columns detected from the S3 path structure

  • pathPrefixstring · required

    S3 path prefix to the parquet files

  • pipeTableIdstring · required

    Internal UUID of the pipe table record

  • sourceStorageNamestring · required

    Source ObjectStorage name

  • tableNamestring · required

    OLAP table name

  • tablePropertiesobject · required

    CREATE TABLE PROPERTIES key-value pairs

  • partitionConfig
GET /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}

(BETA) Delete an AI Lake pipe table

DELETE
/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}

(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress.

(BETA) Delete an AI Lake pipe table › path Parameters

  • instanceIdstring · required

    Database instance identifier. Accepts the database name (preferred) or UUID.

    Database instance identifier. Accepts the database name (preferred) or UUID.

  • tableNamestring · required

    Pipe table name.

    Pipe table name.

(BETA) Delete an AI Lake pipe table › Headers

  • operation-idstring

(BETA) Delete an AI Lake pipe table › Responses

Accepted

DELETE /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}
AI Lake - DatabasesAI Lake - Services & Operations