Type Alias DataField

type DataField = {
    alias?: string;
    dataType: FieldDataType;
    description?: string;
    encrypted?: boolean;
    id?: string;
    index?: number;
    name: string;
    nullable?: boolean;
    ordinalPositionInKey?: number;
    orphan?: boolean;
    primaryKey?: boolean;
    properties?: Record<string, unknown>;
    sensitive?: boolean;
    tags?: string[];
    userTags?: UserTag[];
}
Index
alias? dataType description? encrypted? id? index? name nullable? ordinalPositionInKey? orphan? primaryKey? properties? sensitive? tags? userTags?
alias?: string

Alias of the field. Must be unique within the schema and must not match another field's name. Returns 400 if violated.

dataType: FieldDataType
description?: string
encrypted?: boolean
id?: string

A system-generated, stable identifier for this data field. This is not a classical id - there is no Catalog API to look up a DataField by this value, and it is not indexed.

index?: number
name: string
nullable?: boolean
ordinalPositionInKey?: number
orphan?: boolean
primaryKey?: boolean
properties?: Record<string, unknown>
sensitive?: boolean
tags?: string[]

An array of system tags

userTags?: UserTag[]

An array of user-supplied tags

Settings
Member Visibility

On This Page
Properties