Collection | metaphasejs

Manages a collection of models (rows in a db table) It follows Repository pattern

Hierarchy

Base
- Collection

Index

Constructors

constructor

Properties

model

Methods

Constructors

constructor

new Collection(model: any): Collection

- Defined in orm/collection.ts:24
Parameters
- model: any
Returns Collection

Properties

Protected model

model: any

Methods

Private createColumnRelation

createColumnRelation(index: number): void

- Defined in orm/collection.ts:121
Parameters
- index: number
Returns void

Private createColumns

createColumns(columns: Column[], tableBuilder: TableBuilder): void

- Defined in orm/collection.ts:44
Parameters
- columns: Column[]
- tableBuilder: TableBuilder
Returns void

createModelInstances

createModelInstances(pojos: Object[]): Model[]

- Defined in orm/collection.ts:56
Given an array of pojos it returns an array of model instances

Parameters
- pojos: Object[]
  
  (Plain Old Javascript Object)
Returns Model[]

Private createRelations

createRelations(): void

- Defined in orm/collection.ts:139
Returns void

Private createTable

createTable(tableName: string, columns: Column[]): void

- Defined in orm/collection.ts:34
Parameters
- tableName: string
- columns: Column[]
Returns void

getAll

getAll(load?: object): Model[]

- Defined in orm/collection.ts:63
Parameters
- Default value load: object = {children: false}
  - children: boolean
Returns Model[]

getByFilter

getByFilter(filter: Object, columns?: string[], load?: object): Model[]

- Defined in orm/collection.ts:85
Parameters
- filter: Object
- Default value columns: string[] = []
- Default value load: object = {children: false}
  - children: boolean
Returns Model[]

getById

getById(id: string | number, load?: object): Model

- Defined in orm/collection.ts:75
Parameters
- id: string | number
- Default value load: object = {children: false}
  - children: boolean
Returns Model

getByOperator

getByOperator(termA: any, operator: string, termB: any, columns?: string[], load?: object): Model[]

- Defined in orm/collection.ts:100
Parameters
- termA: any
- operator: string
- termB: any
- Default value columns: string[] = []
- Default value load: object = {children: false}
  - children: boolean
Returns Model[]

Private hasRelations

hasRelations(): boolean

- Defined in orm/collection.ts:117
Returns boolean

Protected insert

insert(model?: any): number | string

Inherited from Base.insert
- Defined in orm/base.ts:21
Parameters
- Optional model: any
Returns number | string

query

query(): any

- Defined in orm/collection.ts:159
Get Knex query-builder for this collection/table

Returns any

remove

remove(model?: any): number

Inherited from Base.remove
- Defined in orm/base.ts:45
Parameters
- Optional model: any
Returns number

save

save(model?: any): number | string

Inherited from Base.save
- Defined in orm/base.ts:33
Parameters
- Optional model: any
Returns number | string

tableName

tableName(): string

Inherited from Base.tableName
- Defined in orm/base.ts:11
Returns string

Protected update

update(model?: any): number | string

Inherited from Base.update
- Defined in orm/base.ts:28
Parameters
- Optional model: any
Returns number | string

Static deleteTable

deleteTable(tableName: string): void

- Defined in orm/collection.ts:180
For posible future use Deletes the table corresponding to the collection

Parameters
- tableName: string
Returns void

Static getTableSchema

getTableSchema(modelClass: any): Object[]

- Defined in orm/collection.ts:151
Get table structure and metadata for a model

Parameters
- modelClass: any
Returns Object[]

Column metadata

Static hasColumn

hasColumn(tableName: string, columnName: string): boolean

- Defined in orm/collection.ts:169
Returns table schema with column metadata

Parameters
- tableName: string
- columnName: string
Returns boolean

Generated using TypeDoc