Member Junction
    Preparing search index...

    Interface ColumnDefinition

    Definition of a single column.

    interface ColumnDefinition {
        DefaultValue?: string;
        Description?: string;
        IsNullable: boolean;
        MaxLength?: number;
        Name: string;
        Precision?: number;
        RawSqlType?: string;
        Scale?: number;
        Type: SchemaFieldType;
    }
    Index

    Properties

    DefaultValue? Description? IsNullable MaxLength? Name Precision? RawSqlType? Scale? Type

    Properties

    DefaultValue?: string

    SQL expression for default value (e.g., "'Active'", "GETUTCDATE()").

    Description?: string

    Human-readable description (sp_addextendedproperty in SQL Server, COMMENT ON in Postgres).

    IsNullable: boolean

    Whether the column accepts NULL.

    MaxLength?: number

    Max length for string types (ignored for non-string types).

    Name: string

    Column name.

    Precision?: number

    Precision for decimal types.

    RawSqlType?: string

    Optional: override with a raw platform-specific SQL type (e.g., "NVARCHAR(200)", "INT"). When set, Type is ignored.

    Scale?: number

    Scale for decimal types.

    Type: SchemaFieldType

    Abstract type — TypeMapper converts to platform SQL type. Alternatively, pass a raw SQL type string via RawSqlType.

    Settings

    Member Visibility

    On This Page

    Properties