Skip to main content
Module

x/typeorm/src/index.ts>Table

Forked from https://github.com/typeorm/typeorm
denolib/typeorm
Latest
class Table
import { Table } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/index.ts";

Table in the database represented in this class.

Constructors

new
Table(options?: TableOptions)

Properties

checks: TableCheck[]

Table check constraints.

columns: TableColumn[]

Table columns.

optional
engine: string

Table engine.

exclusions: TableExclusion[]

Table exclusion constraints.

foreignKeys: TableForeignKey[]

Table foreign keys.

indices: TableIndex[]

Table indices.

justCreated: boolean

Indicates if table was just created. This is needed, for example to check if we need to skip primary keys creation for new tables.

name: string

Contains database name, schema name and table name. E.g. "myDB"."mySchema"."myTable"

readonly
primaryColumns: TableColumn[]
uniques: TableUnique[]

Table unique constraints.

Methods

addCheckConstraint(checkConstraint: TableCheck): void

Adds check constraint.

addColumn(column: TableColumn): void

Add column and creates its constraints.

addExclusionConstraint(exclusionConstraint: TableExclusion): void

Adds exclusion constraint.

addForeignKey(foreignKey: TableForeignKey): void

Adds foreign keys.

addIndex(index: TableIndex, isMysql?: boolean): void

Adds index.

addUniqueConstraint(uniqueConstraint: TableUnique): void

Adds unique constraint.

clone(): Table

Clones this table to a new table with all properties cloned.

findColumnByName(name: string): TableColumn | undefined
findColumnChecks(column: TableColumn): TableCheck[]

Returns all column checks.

findColumnForeignKeys(column: TableColumn): TableForeignKey[]

Returns all column foreign keys.

findColumnIndices(column: TableColumn): TableIndex[]

Returns all column indices.

findColumnUniques(column: TableColumn): TableUnique[]

Returns all column uniques.

removeCheckConstraint(removedCheck: TableCheck): void

Removes check constraint.

removeColumn(column: TableColumn): void

Remove column and its constraints.

removeExclusionConstraint(removedExclusion: TableExclusion): void

Removes exclusion constraint.

removeForeignKey(removedForeignKey: TableForeignKey): void

Removes foreign key.

removeIndex(tableIndex: TableIndex, isMysql?: boolean): void

Removes index.

removeUniqueConstraint(removedUnique: TableUnique): void

Removes unique constraint.

Static Methods

create(entityMetadata: EntityMetadata, driver: Driver): Table

Creates table from a given entity metadata.