Class Table

Hierarchy

Table

Constructors

constructor

new Table(name: string): Table
Parameters
- name: string
Returns Table
- Defined in packages/sql/src/schema/table.ts:65

Properties

alias

alias: string = ''

columnForProperty

columnForProperty: Map<ReflectionProperty, Column> = ...

columns

columns: Column[] = []

foreignKeys

foreignKeys: ForeignKey[] = []

indices

indices: IndexModel[] = []

name

name: string

schemaName

schemaName: string = ''

Methods

addColumn

addColumn(name: string, property?: ReflectionProperty): Column
Parameters
- name: string
- Optional property: ReflectionProperty
Returns Column
- Defined in packages/sql/src/schema/table.ts:83

addForeignKey

addForeignKey(name: string, foreignTable: Table): ForeignKey
Parameters
- name: string
- foreignTable: Table
Returns ForeignKey
- Defined in packages/sql/src/schema/table.ts:96

addIndex

addIndex(name: string, unique?: boolean): IndexModel
Parameters
- name: string
- unique: boolean = false
Returns IndexModel
- Defined in packages/sql/src/schema/table.ts:90

getAutoIncrements

getAutoIncrements(): Column[]
Returns Column[]
- Defined in packages/sql/src/schema/table.ts:122

getColumn

getColumn(name: string): Column
Parameters
- name: string
Returns Column
- Defined in packages/sql/src/schema/table.ts:106

getColumnForProperty

getColumnForProperty(property: ReflectionProperty): Column
Parameters
- property: ReflectionProperty
Returns Column
- Defined in packages/sql/src/schema/table.ts:112

getForeignKeyOfLocalColumn

getForeignKeyOfLocalColumn(column: Column): undefined | ForeignKey
Parameters
- column: Column
Returns undefined | ForeignKey
- Defined in packages/sql/src/schema/table.ts:146

getFullName

getFullName(schemaDelimiter: string): string
Parameters
- schemaDelimiter: string
Returns string
- Defined in packages/sql/src/schema/table.ts:79

getIndex

getIndex(name: string): undefined | IndexModel
Parameters
- name: string
Returns undefined | IndexModel
- Defined in packages/sql/src/schema/table.ts:130

getIndices

getIndices(): IndexModel[]
Returns IndexModel[]
- Defined in packages/sql/src/schema/table.ts:126

getName

getName(): string
Returns string
- Defined in packages/sql/src/schema/table.ts:75

getPrimaryKeys

getPrimaryKeys(): Column[]
Returns Column[]
- Defined in packages/sql/src/schema/table.ts:118

getUnices

getUnices(): IndexModel[]
Returns IndexModel[]
- Defined in packages/sql/src/schema/table.ts:134

hasColumn

hasColumn(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/sql/src/schema/table.ts:102

hasCompositePrimaryKey

hasCompositePrimaryKey(): boolean
Returns boolean
- Defined in packages/sql/src/schema/table.ts:142

hasIndex

hasIndex(columns: Column[], unique?: boolean): boolean
Parameters
- columns: Column[]
- unique: boolean = false
Returns boolean
- Defined in packages/sql/src/schema/table.ts:160

hasIndexByName

hasIndexByName(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in packages/sql/src/schema/table.ts:153

hasPrimaryKey

hasPrimaryKey(): boolean
Returns boolean
- Defined in packages/sql/src/schema/table.ts:138

isName

isName(name: string, schemaName?: string): boolean
Parameters
- name: string
- Optional schemaName: string
Returns boolean
- Defined in packages/sql/src/schema/table.ts:70

Generated using TypeDoc