Skip to content

Column

Contexts

Context Relationship Object Path Package File Path
Database.TableList.Table.columns Package -> Database -> TableList -> Table -> Column $.databases[*].tables.schemas[*].columns[*] {package-root}/databases/{db-name}/
TableList.Table.columns Package -> TableList -> Table -> Column $.tables.schemas[*].columns[*] {package-root}/tables/{table-name}.yaml

Fields

Field Type Required Description Constraints Default
type Type2 yes A Q type name - -
anymap boolean | null no Indicates if nested data can be stored as a memory mapped 'anymap' file. - null
attrDisk AttrDisk | null no Column attributes to apply when the table is partitioned on disk - null
attrMem AttrDisk | null no Column attributes to apply when the table is in memory. - null
attrObj AttrDisk | null no Column attribute (on-disk HDB in object store e.g. S3) - null
attrOrd AttrDisk | null no Column attributes to apply when the table is ordinal partitioned. - null
backfill string | null no The name of the function to call to get the value for the column when backfilling it. pattern: "^[a-zA-Z.]+[a-zA-Z0-9_.]*$" null
description string | null no A textual description of the column for documentation purposes. - "KXI Assembly Schema Column"
foreign string | null no Indicates the values of this column are a foreign key into a column in another table. This value should be in the form of table.column, where the table is another table in the same schema and the column is in that table. pattern: "^[a-zA-Z][a-zA-Z0-9_]*.[a-zA-Z][a-zA-Z0-9_]*$" null
name string | null no The name of the column pattern: "^[a-zA-Z][a-zA-Z0-9_]*$" null
oldName string | null no Indicates the name of a previous version of this column. This is used when renaming a column pattern: "^[a-zA-Z][a-zA-Z0-9_]*$" null

Used In

Back to top