Keboola · Schema

CreateTableAsyncFromWorkspaceRequest

Request body for creating a table from a workspace. Some parameters are optional or only used for specific backends.

Data PlatformETLELTData PipelinesData StorageTransformationsOrchestrationData OperationsCloud DataSnowflakeBigQuery

Properties

Name Type Description
dataWorkspaceId integer ID of the source workspace.
dataObject string Name of the object in the workspace (table, file, etc).
dataTableName string Deprecated: use dataObject. Name of the table in the workspace.
name string Name of the new table.
delimiter string CSV delimiter character.
enclosure string CSV enclosure character.
escapedBy string CSV escape character.
primaryKey array Primary key columns.
columns array List of table columns (optional, only for file workspace).
distributionKey array Distribution key columns (for Synapse).
timestampType string Type of internal timestamp column only MANAGED value now supported, meaning that _timestamp column managed by storage is created.
View JSON Schema on GitHub

JSON Schema

keboola-createtableasyncfromworkspacerequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateTableAsyncFromWorkspaceRequest",
  "description": "Request body for creating a table from a workspace. Some parameters are optional or only used for specific backends.",
  "required": [
    "dataWorkspaceId",
    "name",
    "primaryKey",
    "distributionKey"
  ],
  "properties": {
    "dataWorkspaceId": {
      "description": "ID of the source workspace.",
      "type": "integer"
    },
    "dataObject": {
      "description": "Name of the object in the workspace (table, file, etc).",
      "type": "string",
      "nullable": true
    },
    "dataTableName": {
      "description": "Deprecated: use dataObject. Name of the table in the workspace.",
      "type": "string",
      "nullable": true
    },
    "name": {
      "description": "Name of the new table.",
      "type": "string"
    },
    "delimiter": {
      "description": "CSV delimiter character.",
      "type": "string",
      "nullable": true
    },
    "enclosure": {
      "description": "CSV enclosure character.",
      "type": "string",
      "nullable": true
    },
    "escapedBy": {
      "description": "CSV escape character.",
      "type": "string",
      "nullable": true
    },
    "primaryKey": {
      "description": "Primary key columns.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "columns": {
      "description": "List of table columns (optional, only for file workspace).",
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "distributionKey": {
      "description": "Distribution key columns (for Synapse).",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timestampType": {
      "description": "Type of internal timestamp column only MANAGED value now supported, meaning that _timestamp column managed by storage is created.",
      "type": "string",
      "nullable": true,
      "default": "MANAGED"
    }
  },
  "type": "object"
}