Interface EntityDefinition<TInstance>

interface EntityDefinition<TInstance extends object = object> {
    table?: string;
    columns?: Record<string, ColumnDefinition>;
    primaryKey?: string | string[] | PrimaryKeyDefinition;
    foreignKeys?: ForeignKeyDefinition[];
    indexes?: IndexDefinition[];
}

Type Parameters

TInstance extends object = object

Index

Properties

table? columns? primaryKey? foreignKeys? indexes?

Properties

`Optional`table

table?: string

`Optional`columns

columns?: Record<string, ColumnDefinition>

`Optional`primaryKey

primaryKey?: string | string[] | PrimaryKeyDefinition

`Optional`foreignKeys

foreignKeys?: ForeignKeyDefinition[]

`Optional`indexes

indexes?: IndexDefinition[]