Class RelationalTable

Hierarchy

RelationalTable

Implements

IRelationalTable

Index

Constructors

constructor

Properties

dummyRecords

Accessors

cascade
name

Methods

Constructors

constructor

new RelationalTable(options: IRelationalTableOptions, dummyRecords: DummyRecords): RelationalTable

- Defined in relational/table.ts:52
Parameters
- options: IRelationalTableOptions
- dummyRecords: DummyRecords
Returns RelationalTable

Properties

dummyRecords

dummyRecords: DummyRecords

Accessors

cascade

get cascade(): boolean

- Defined in relational/table.ts:87
Returns boolean

name

get name(): string

- Defined in relational/table.ts:83
Returns string

Methods

add

add(model: object): IFullModelLike

Implementation of IRelationalTable.add
- Defined in relational/table.ts:189
Adds an item in the Table and recursively add foreign items.

Parameters
- model: object
Returns IFullModelLike

addForeignRelation

addForeignRelation(foreignKey: string, foreignTable: IRelationalTable): void

Implementation of IRelationalTable.addForeignRelation
- Defined in relational/table.ts:240
Adds a foreign relation.

Parameters
- foreignKey: string
- foreignTable: IRelationalTable
Returns void

addMany

addMany(models: any[]): IFullModelLike[]

Implementation of IRelationalTable.addMany
- Defined in relational/table.ts:231
Add many items into a table.

Parameters
- models: any[]
Returns IFullModelLike[]

addReverseForeignRelation

addReverseForeignRelation(reverseForeignKey: string, table: IRelationalTable): void

Implementation of IRelationalTable.addReverseForeignRelation
- Defined in relational/table.ts:250
Add a reverse foreign relation.

Parameters
- reverseForeignKey: string
- table: IRelationalTable
Returns void

dataProvider

dataProvider(): IFullBackboneCollectionLike

Implementation of IRelationalTable.dataProvider
- Defined in relational/table.ts:91
Returns IFullBackboneCollectionLike

destroy

destroy(): void

Implementation of IRelationalTable.destroy
- Defined in relational/table.ts:284
Destroys table

Returns void

get

get(id: any): IFullModelLike

Implementation of IRelationalTable.get
- Defined in relational/table.ts:158
Gets the model in the table by id.

Parameters
- id: any
Returns IFullModelLike

hasForeignRelation

hasForeignRelation(foreignKey: string): boolean

Implementation of IRelationalTable.hasForeignRelation
- Defined in relational/table.ts:270
Check if a given foreign relation is present.

Parameters
- foreignKey: string
Returns boolean

hasReverseForeignRelation

hasReverseForeignRelation(reverseForeignKey: string): boolean

Implementation of IRelationalTable.hasReverseForeignRelation
- Defined in relational/table.ts:277
Checks if a given reverse foreign relation is present.

Parameters
- reverseForeignKey: string
Returns boolean

onDeleted

onDeleted(): void

- Defined in relational/table.ts:96
Returns void

Generated using TypeDoc