Skip to main content

LogicalCreate

Logical type creation request. Collection-bound: a schema resolves a name in its own collection, never a global one.

nameName (string)required

Possible values: non-empty and <= 63 characters, Value must match regular expression ^[a-z][a-z0-9_]{0,62}(?![\s\S])

alias object
anyOf
string
collection_idCollection Id (string)required

Possible values: non-empty

tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    requiresstring[]
    outputs objectrequired

    Arrow schema JSON a read produces ({'fields': [...]})

    property name*any

    Arrow schema JSON a read produces ({'fields': [...]})

    inputs object

    Arrow schema JSON of the stored document when input is 'inputs' ({'fields': [...]})

    anyOf
    object
    inputInput (string)required

    What the column stores, in the format the writer keeps: 'outputs' = the outputs fields as one JSON document; 'inputs' = the inputs fields as one JSON document, which the reader turns into outputs; 'raw' = the original value, which the reader turns into outputs

    Possible values: [outputs, inputs, raw]

    reader object
    anyOf
    string
    options object
    property name*any
    LogicalCreate
    {
      "name": "string",
      "alias": "string",
      "collection_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "requires": [
        "string"
      ],
      "outputs": {},
      "inputs": {},
      "input": "outputs",
      "reader": "string",
      "options": {}
    }