Skip to main content

DatasetCreate

Payload used to create Dataset. Required fields are name, type, collection_id.

nameName (string)required

lower_snake_case identifier from 1 to 63 characters. It must start with a lowercase letter or underscore and may contain lowercase letters, digits, and underscores.

Possible values: Value must match regular expression ^[a-z_][a-z0-9_]{0,62}$

alias object
anyOf
string
typeType (string)required

Dataset backend type: 'delta' | 'kafka' | 'rest' | 'object' (required)

Possible values: [delta, kafka, rest, object]

collection_idCollection Id (string)required

Parent collection ID (required)

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    schema object

    Dataset column schema in JSON. Optional metadata.keys is a comma-separated, ordered list of columns that identify rows for upsert.

    anyOf
    object
    options object
    anyOf
    object
    DatasetCreate
    {
      "name": "string",
      "alias": "string",
      "type": "delta",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "schema": {},
      "options": {}
    }