Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableBuilder

Builder to specify the schema of a table.

Hierarchy

Index

Constructors

constructor

Properties

Protected columns

columns: {} = {}

Mapping of column name to column schemata.

Type declaration

Protected constraints

constraints: {} = {}

Mapping of constraint name to constraint schemata.

Type declaration

Protected dirty

dirty: boolean = false

True if the schema has been modified since created/loaded.

Protected existsInSchema

existsInSchema: boolean = false

True if this resource exists, in some form, in the schema.

Protected indexes

indexes: {} = {}

Mapping of index name to index schemata.

Type declaration

Readonly name

name: string

Optional originalFromSchema

originalFromSchema: TableBuilder

If the resource exists in the schema, the unaltered values it has.

Protected shouldDrop

shouldDrop: "yes" | "no" | "exists" = 'no'

Whether or not the schema item should be dropped.

  • exists - drop if exists

Protected Optional shouldRenameTo

shouldRenameTo: string

The name the schema item should have if renaming.

Protected shouldSkipIfExists

shouldSkipIfExists: boolean = false

If true, apply IF NOT EXISTS syntax.

Methods

check

Protected cloneInstance

cloneTo

column

constraint

drop

dropColumn

dropIfExists

dropIndex

flagAsExistingInSchema

getColumns

  • getColumns(): {}

getConstraints

  • getConstraints(): {}

getIndexes

  • getIndexes(): {}

Protected getNextAvailableConstraintName

getRename

  • getRename(): Maybe<string>

ifNotExists

index

isDirty

  • isDirty(): boolean

isDropping

  • isDropping(): boolean

isDroppingIfExists

  • isDroppingIfExists(): boolean

isExisting

  • isExisting(): boolean

isSkippedIfExisting

  • isSkippedIfExisting(): boolean

pipe

primaryKey

rename

renameColumn

renameIndex

unique

Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.