Member Junction
    Preparing search index...

    Interface ERDField

    Represents a field in an ERD node (entity).

    interface ERDField {
        allowsNull?: boolean;
        autoIncrement?: boolean;
        customData?: Record<string, unknown>;
        defaultValue?: string;
        description?: string;
        id: string;
        isPrimaryKey: boolean;
        isVirtual?: boolean;
        length?: number;
        name: string;
        possibleValues?: ERDFieldValue[];
        precision?: number;
        relatedFieldName?: string;
        relatedNodeId?: string;
        relatedNodeName?: string;
        scale?: number;
        type?: string;
    }
    Index

    Properties

    allowsNull? autoIncrement? customData? defaultValue? description? id isPrimaryKey isVirtual? length? name possibleValues? precision? relatedFieldName? relatedNodeId? relatedNodeName? scale? type?

    Properties

    allowsNull?: boolean

    Whether the field allows null values

    autoIncrement?: boolean

    Whether the field is auto-increment

    customData?: Record<string, unknown>

    Additional custom data

    defaultValue?: string

    Default value for the field

    description?: string

    Optional description of the field

    id: string

    Unique identifier for the field

    isPrimaryKey: boolean

    Whether this field is a primary key

    isVirtual?: boolean

    Whether the field is virtual/computed

    length?: number

    Maximum length (for string fields)

    name: string

    Display name of the field

    possibleValues?: ERDFieldValue[]

    Possible values for the field (for enums/dropdowns)

    precision?: number

    Precision (for numeric fields)

    relatedFieldName?: string

    Name of the field in the related node (for FK relationships)

    relatedNodeId?: string

    ID of the related node (for foreign keys)

    relatedNodeName?: string

    Name of the related node (for display purposes)

    scale?: number

    Scale (for numeric fields)

    type?: string

    Data type of the field (e.g., 'string', 'int', 'uuid')

    Settings

    Member Visibility

    On This Page

    Properties