Polyglot SQL API Documentation - v0.2.0
    Preparing search index...

    Interface ColumnSchema

    Column definition in a table schema.

    interface ColumnSchema {
        name: string;
        nullable?: boolean;
        primaryKey?: boolean;
        references?: { column: string; schema?: string; table: string };
        type: string;
        unique?: boolean;
    }
    Index

    Properties

    name nullable? primaryKey? references? type unique?

    Properties

    name: string

    Column name

    nullable?: boolean

    Whether the column allows NULL values

    primaryKey?: boolean

    Whether this column is a primary key

    references?: { column: string; schema?: string; table: string }

    Foreign key reference to another table. Used for validating join conditions.

    type: string

    Column data type (e.g., "integer", "varchar", "timestamp"). Type names are case-insensitive.

    unique?: boolean

    Whether this column has a uniqueness constraint

    Settings

    Member Visibility

    On This Page

    Properties