Column | metaphasejs

Hierarchy

Column

Implements

IColumn

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Column(__namedParameters: object): Column

- Defined in orm/column.ts:39
Parameters
- __namedParameters: object
  - dbType: any
  - defaultValue: any
  - foreignKey: undefined | true | false
  - index: undefined | true | false
  - name: undefined | string
  - notNullable: undefined | true | false
  - relatedTable: undefined | string
  - size: undefined | number
  - unique: undefined | true | false
Returns Column

Properties

Optional dbType

dbType: DBtype

Optional defaultValue

defaultValue: any

Optional foreignKey

foreignKey: undefined | true | false

Optional index

index: undefined | true | false

Optional name

name: undefined | string

Optional notNullable

notNullable: undefined | true | false

Optional relatedTable

relatedTable: undefined | string

Optional size

size: undefined | number

Optional unique

unique: undefined | true | false

Methods

createColumn

createColumn(table: TableBuilder | any): any

- Defined in orm/column.ts:97
Create table columns based in column properties

Parameters
- table: TableBuilder | any
Returns any

createColumnsRelation

createColumnsRelation(table: TableBuilder): void

- Defined in orm/column.ts:76
Creates foreign key relation between two columns in two tables Column 1: primary key column ('id') Column 2: foreign key column (_id) Table 1: table Table 2: this.relatedTable Note: ColumnAction = 'Cascade' by default. Not configurable by now

Parameters
- table: TableBuilder
Returns void

isForeignKey

isForeignKey(): boolean

- Defined in orm/column.ts:149
Returns boolean

Static Private addIndex

addIndex(newColumn: any, tableBuilder: TableBuilder | any, colType: DBtype, colName: string): TableBuilder

- Defined in orm/column.ts:136
Parameters
- newColumn: any
- tableBuilder: TableBuilder | any
- colType: DBtype
- colName: string
Returns TableBuilder

Static Private addUniqueConstraint

addUniqueConstraint(newColumn: any, tableBuilder: TableBuilder | any, colType: DBtype, colName: string): TableBuilder

- Defined in orm/column.ts:123
Parameters
- newColumn: any
- tableBuilder: TableBuilder | any
- colType: DBtype
- colName: string
Returns TableBuilder

Generated using TypeDoc