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

    Interface TableSchema

    Table definition in the schema.

    interface TableSchema {
        aliases?: string[];
        columns: ColumnSchema[];
        foreignKeys?: TableForeignKey[];
        name: string;
        primaryKey?: string[];
        schema?: string;
        uniqueKeys?: string[][];
    }
    Index

    Properties

    aliases? columns foreignKeys? name primaryKey? schema? uniqueKeys?

    Properties

    aliases?: string[]

    Aliases that can refer to this table

    columns: ColumnSchema[]

    Column definitions

    foreignKeys?: TableForeignKey[]

    Table-level foreign keys

    name: string

    Table name

    primaryKey?: string[]

    Primary key columns

    schema?: string

    Schema/namespace name (e.g., "public", "dbo")

    uniqueKeys?: string[][]

    Unique key groups (composite keys allowed)

    Settings

    Member Visibility

    On This Page

    Properties