Class BaseModel

Base class for models

Index

Constructors

Properties

id? _adapter _associations _connection _initialize_called _integrities _intermediate_paths _name _object_column_classes? _property_decorators? _schema archive description? dirty_tracking lean_query query_record_id_as_string table_name

Constructors

constructor

new BaseModel(data?): BaseModel
Creates a record
Parameters
- Optionaldata: object
Returns BaseModel
- Defined in packages/cormo/src/model/index.ts:992

Properties

`Optional` `Readonly`id

id?: any

`Static`_adapter

_adapter: AdapterBase

Indicates the adapter associated to this model

`Static`_associations

_associations: {
[column: string]: any;
}

`Static`_connection

_connection: Connection<AdapterBase>

Indicates the connection associated to this model

`Static`_initialize_called

_initialize_called: boolean = false

`Static`_integrities

_integrities: {
    child?: typeof BaseModel;
    column: string;
    parent?: typeof BaseModel;
    type: string;
}[]

`Static`_intermediate_paths

_intermediate_paths: any

`Static`_name

_name: string

`Static` `Optional`_object_column_classes

_object_column_classes?: {
column: string;
klass: any;
}[]

`Static` `Optional`_property_decorators

_property_decorators?: any[]

`Static`_schema

_schema: ModelSchemaInternal

`Static`archive

archive: boolean = false

Archives deleted records in the archive table

`Static` `Optional`description

description?: string

`Static`dirty_tracking

dirty_tracking: boolean = false

Tracks changes of a record if true

`Static`lean_query

lean_query: boolean = false

Applies the lean option for all queries for this Model

`Static`query_record_id_as_string

query_record_id_as_string: boolean = false

Forces to return record id as string. It remains as number on the persisted record if the adapter uses number for record id.

`Static`table_name

table_name: string

Methods

_defineProperty

_defineProperty(object, key, path, enumerable): void
Parameters
- object: any
- key: any
- path: any
- enumerable: any
Returns void
- Defined in packages/cormo/src/model/index.ts:1163

destroy

destroy(): Promise<void>
Destroys this record (remove from the database)

Returns Promise<void>
- Defined in packages/cormo/src/model/index.ts:1151

get

get(path): any
Returns the current value of the column of the given path
Parameters
- path: any
Returns any
- Defined in packages/cormo/src/model/index.ts:1090

getChanged

getChanged(): string[]
Returns the list of paths of changed columns

Returns string[]
- Defined in packages/cormo/src/model/index.ts:1083

getPrevious

getPrevious(path): any
Returns the original value of the column of the given path
Parameters
- path: any
Returns any
- Defined in packages/cormo/src/model/index.ts:1101

isDirty

isDirty(): boolean
Returns true if there is some changed columns

Returns boolean
- Defined in packages/cormo/src/model/index.ts:1076

reset

reset(): void
Resets all changes

Returns void
- Defined in packages/cormo/src/model/index.ts:1140

save

save(options?): Promise<BaseModel>
Saves data to the database
Parameters
- options: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data?: boolean;
      validate?: boolean;
  } = {}
  - Optionalskip_log?: boolean
  - Optionaltransaction?: Transaction
  - Optionaluse_id_in_data?: boolean
  - Optionalvalidate?: boolean
Returns Promise<BaseModel>
- Defined in packages/cormo/src/model/index.ts:1179

set

set(path, value): void
Changes the value of the column of the given path
Parameters
- path: any
- value: any
Returns void
- Defined in packages/cormo/src/model/index.ts:1108

validate

validate(): void
Validates data

Returns void
- Defined in packages/cormo/src/model/index.ts:1215

`Static`_buildSaveDataColumn

_buildSaveDataColumn(data, model, column, property, allow_null?): void
Parameters
- data: any
- model: any
- column: string
- property: ColumnPropertyInternal
- allow_null: boolean = false
Returns void
- Defined in packages/cormo/src/model/index.ts:788

`Static`_checkConnection

_checkConnection(): void
Returns void
- Defined in packages/cormo/src/model/index.ts:200

`Static`_checkReady

_checkReady(): Promise<void>
Returns Promise<void>
- Defined in packages/cormo/src/model/index.ts:210

`Static`_collapseNestedNulls

_collapseNestedNulls(instance, selected_columns_raw, intermediates): void
Set nested object null if all children are null
Parameters
- instance: any
- selected_columns_raw: any
- intermediates: any
Returns void
- Defined in packages/cormo/src/model/index.ts:395

`Static`_getKeyType

_getKeyType(target_connection?): any
Parameters
- target_connection: Connection<AdapterBase> = ...
Returns any
- Defined in packages/cormo/src/model/index.ts:384

`Static`_loadFromCache

_loadFromCache(key, refresh?): Promise<any>
Parameters
- key: string
- Optionalrefresh: boolean
Returns Promise<any>
- Defined in packages/cormo/src/model/index.ts:421

`Static`_saveToCache

_saveToCache(key, ttl, data): Promise<void>
Parameters
- key: string
- ttl: number
- data: any
Returns Promise<void>
- Defined in packages/cormo/src/model/index.ts:442

`Static`_validateColumn

_validateColumn(data, column, property, for_update?): void
Parameters
- data: any
- column: string
- property: ColumnPropertyInternal
- for_update: boolean = false
Returns void
- Defined in packages/cormo/src/model/index.ts:807

`Static`[custom]

[custom](_depth): string
Parameters
- _depth: number
Returns string
- Defined in packages/cormo/src/model/index.ts:376

`Static`addValidator

addValidator(validator): void
Adds a validator A validator must return false(boolean) or error message(string), or throw an Error exception if invalid
Parameters
- validator: any
Returns void
- Defined in packages/cormo/src/model/index.ts:783

`Static`afterCreate

afterCreate(method): void
Adds a callback of after creating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:504

`Static`afterDestroy

afterDestroy(method): void
Adds a callback of after destroying
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:532

`Static`afterFind

afterFind(method): void
Adds a callback of after finding
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:476

`Static`afterInitialize

afterInitialize(method): void
Adds a callback of after initializing
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:469

`Static`afterSave

afterSave(method): void
Adds a callback of after saving
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:490

`Static`afterUpdate

afterUpdate(method): void
Adds a callback of after updating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:518

`Static`afterValidate

afterValidate(method): void
Adds a callback of after validating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:546

`Static`applyDefaultValues

applyDefaultValues(obj): string[]
Parameters
- obj: any
Returns string[]
- Defined in packages/cormo/src/model/index.ts:1379

`Static`beforeCreate

beforeCreate(method): void
Adds a callback of before creating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:497

`Static`beforeDestroy

beforeDestroy(method): void
Adds a callback of before destroying
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:525

`Static`beforeSave

beforeSave(method): void
Adds a callback of before saving
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:483

`Static`beforeUpdate

beforeUpdate(method): void
Adds a callback of before updating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:511

`Static`beforeValidate

beforeValidate(method): void
Adds a callback of before validating
Parameters
- method: ModelCallbackMethod
Returns void
- Defined in packages/cormo/src/model/index.ts:539

`Static`belongsTo

belongsTo(target_model_or_column, options?): void
Adds a belongs-to association
Parameters
- target_model_or_column: string | typeof BaseModel
- Optionaloptions: AssociationBelongsToOptions
Returns void
- Defined in packages/cormo/src/model/index.ts:371

`Static`build

build<M>(this, data, options): M
Creates a record. 'Model.build(data)' is the same as 'new Model(data)'
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M)
  - - new (data_arg?): M
    - Parameters
      Optionaldata_arg: any
      Returns M
- data: ModelValueObjectWithId<M>
- options: {
  use_id_in_data: true;
  }
  - use_id_in_data: true
Returns M
- Defined in packages/cormo/src/model/index.ts:318
build<M>(this, data?, options?): M
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M)
  - - new (data_arg?): M
    - Parameters
      Optionaldata_arg: any
      Returns M
- Optionaldata: ModelValueObject<M>
- Optionaloptions: {
  use_id_in_data?: boolean;
  }
  - Optionaluse_id_in_data?: boolean
Returns M
- Defined in packages/cormo/src/model/index.ts:323

`Static`column

column(path, type_or_property): void
Adds a column to this model
Parameters
- path: string
- type_or_property:
      | ColumnType
      | ColumnType[]
      | ColumnProperty
      | ColumnNestedProperty
Returns void
- Defined in packages/cormo/src/model/index.ts:218

`Static`connection

connection(connection, name?): void
Sets a connection of this model

If this methods was not called explicitly, this model will use Connection.defaultConnection
Parameters
- connection: Connection<AdapterBase>
- Optionalname: string
Returns void
- Defined in packages/cormo/src/model/index.ts:176

`Static`count

count(condition?, options?): Promise<number>
Counts records by conditions
Parameters
- Optionalcondition: object
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns Promise<number>
- Defined in packages/cormo/src/model/index.ts:741

`Static`create

create<M>(this, data, options): Promise<M>
Creates a record and saves it to the database 'Model.create(data)' is the same as 'Model.build(data).save()'
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M) & typeof BaseModel
- data: ModelValueObjectWithId<M>
- options: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data: true;
  }
  - Optionalskip_log?: boolean
  - Optionaltransaction?: Transaction
  - use_id_in_data: true
Returns Promise<M>
- Defined in packages/cormo/src/model/index.ts:554
create<M>(this, data?, options?): Promise<M>
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M) & typeof BaseModel
- Optionaldata: ModelValueObject<M>
- Optionaloptions: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data?: boolean;
  }
  - Optionalskip_log?: boolean
  - Optionaltransaction?: Transaction
  - Optionaluse_id_in_data?: boolean
Returns Promise<M>
- Defined in packages/cormo/src/model/index.ts:559

`Static`createBulk

createBulk<M>(this, data, options): Promise<M[]>
Creates multiple records and saves them to the database.
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M) & typeof BaseModel
- data: ModelValueObjectWithId<M>[]
- options: {
  transaction?: Transaction;
  use_id_in_data: true;
  }
  - Optionaltransaction?: Transaction
  - use_id_in_data: true
Returns Promise<M[]>
- Defined in packages/cormo/src/model/index.ts:576
createBulk<M>(this, data?, options?): Promise<M[]>
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data_arg?: any) => M) & typeof BaseModel
- Optionaldata: ModelValueObject<M>[]
- Optionaloptions: {
  transaction?: Transaction;
  use_id_in_data?: boolean;
  }
  - Optionaltransaction?: Transaction
  - Optionaluse_id_in_data?: boolean
Returns Promise<M[]>
- Defined in packages/cormo/src/model/index.ts:581

`Static`delete

delete(condition?, options?): Promise<number>
Deletes records by conditions
Parameters
- Optionalcondition: object
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns Promise<number>
- Defined in packages/cormo/src/model/index.ts:759

`Static`deleteAll

deleteAll(): Promise<void>
Deletes all records from the database

Returns Promise<void>
- Defined in packages/cormo/src/model/index.ts:348

`Static`drop

drop(): Promise<void>
Drops this model from the database

Returns Promise<void>
See
AdapterBase::drop
- Defined in packages/cormo/src/model/index.ts:304

`Static`find

find<M>(this, id, options?): QuerySingle<M, M>
Finds a record by id
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- id: CormoTypesRecordID
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QuerySingle<M, M>
Throws
- Defined in packages/cormo/src/model/index.ts:635
find<M>(this, id, options?): QueryArray<M, M>
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- id: CormoTypesRecordID[]
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, M>
- Defined in packages/cormo/src/model/index.ts:640

`Static`findPreserve

findPreserve<M>(this, ids, options?): QueryArray<M, M>
Finds records by ids while preserving order.
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- ids: CormoTypesRecordID[]
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, M>
Throws
- Defined in packages/cormo/src/model/index.ts:657

`Static`group

group<M, G, F>(this, group_by, fields?, options?): QueryArray<M, {
[field in string | number | symbol]: number
} & Pick<M, G>>
Groups result records
Type Parameters
- M extends BaseModel
- G extends string | number | symbol
- F
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- group_by: G | G[]
- Optionalfields: F
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, {
[field in string | number | symbol]: number
} & Pick<M, G>>
- Defined in packages/cormo/src/model/index.ts:711
group<M, F>(this, group_by, fields?, options?): QueryArray<M, {
[field in string | number | symbol]: number
}>
Type Parameters
- M extends BaseModel
- F
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- group_by: null
- Optionalfields: F
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, {
[field in string | number | symbol]: number
}>
- Defined in packages/cormo/src/model/index.ts:717
group<M, U>(this, group_by, fields?, options?): QueryArray<M, U>
Type Parameters
- M extends BaseModel
- U
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- group_by: null | string
- Optionalfields: object
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, U>
- Defined in packages/cormo/src/model/index.ts:723

`Static`hasMany

hasMany(target_model_or_column, options?): void
Adds a has-many association
Parameters
- target_model_or_column: string | typeof BaseModel
- Optionaloptions: AssociationHasManyOptions
Returns void
- Defined in packages/cormo/src/model/index.ts:355

`Static`hasOne

hasOne(target_model_or_column, options?): void
Adds a has-one association
Parameters
- target_model_or_column: string | typeof BaseModel
- Optionaloptions: AssociationHasOneOptions
Returns void
- Defined in packages/cormo/src/model/index.ts:363

`Static`index

index(columns, options?): void
Adds an index to this model
Parameters
- columns: {
  [column: string]: 1 | -1;
  }
  - [column: string]: 1 | -1
- options: {
  name?: string;
  unique?: boolean;
  } = {}
  - Optionalname?: string
  - Optionalunique?: boolean
Returns void
- Defined in packages/cormo/src/model/index.ts:294

`Static`initialize

initialize(): void
Returns void
- Defined in packages/cormo/src/model/index.ts:154

`Static`newModel

newModel(connection, name, schema): typeof BaseModel
Returns a new model class extending BaseModel
Parameters
- connection: Connection<AdapterBase>
- name: string
- schema: ModelSchema
Returns typeof BaseModel
- Defined in packages/cormo/src/model/index.ts:161

`Static`order

order<M>(this, orders, options?): QueryArray<M, M>
Specifies orders of result
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- orders: string
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, M>
- Defined in packages/cormo/src/model/index.ts:700

`Static`query

query<M>(this, options?): QueryArray<M, M>
Creates q query object
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, M>
- Defined in packages/cormo/src/model/index.ts:624

`Static`removeCache

removeCache(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in packages/cormo/src/model/index.ts:456

`Static`select

select<M, K>(this, columns, options?): QueryArray<M, Pick<M, K>>
Selects columns for result
Type Parameters
- M extends BaseModel
- K extends string | number | symbol
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- columns: K[]
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, Pick<M, K>>
- Defined in packages/cormo/src/model/index.ts:679
select<M, K>(this, columns?, options?): QueryArray<M, Pick<M, K>>
Type Parameters
- M extends BaseModel
- K extends string | number | symbol
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- Optionalcolumns: string
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, Pick<M, K>>
- Defined in packages/cormo/src/model/index.ts:684

`Static`timestamps

timestamps(): void
Adds 'created_at' and 'updated_at' fields to records

Returns void
- Defined in packages/cormo/src/model/index.ts:766

`Static`update

update(updates, condition?, options?): Promise<number>
Updates some fields of records that match conditions
Parameters
- updates: any
- Optionalcondition: object
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns Promise<number>
- Defined in packages/cormo/src/model/index.ts:748

`Static`where

where<M>(this, condition?, options?): QueryArray<M, M>
Finds records by conditions
Type Parameters
- M extends BaseModel
Parameters
- this: (new (data?: any) => M) & typeof BaseModel
- Optionalcondition: object
- Optionaloptions: {
  transaction?: Transaction;
  }
  - Optionaltransaction?: Transaction
Returns QueryArray<M, M>
- Defined in packages/cormo/src/model/index.ts:668

Class BaseModel

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseModel

Properties

Optional Readonlyid

Static_adapter

Static_associations

Static_connection

Static_initialize_called

Static_integrities

Static_intermediate_paths

Static_name

Static Optional_object_column_classes

Static Optional_property_decorators

Static_schema

Staticarchive

Static Optionaldescription

Staticdirty_tracking

Staticlean_query

Staticquery_record_id_as_string

Statictable_name

Methods

_defineProperty

Parameters

Returns void

destroy

Returns Promise<void>

get

Parameters

Returns any

getChanged

Returns string[]

getPrevious

Parameters

Returns any

isDirty

Returns boolean

reset

Returns void

save

Parameters

Optionalskip_log?: boolean

Optionaltransaction?: Transaction

Optionaluse_id_in_data?: boolean

Optionalvalidate?: boolean

Returns Promise<BaseModel>

set

Parameters

Returns void

validate

Returns void

Static_buildSaveDataColumn

Parameters

Returns void

Static_checkConnection

Returns void

Static_checkReady

Returns Promise<void>

Static_collapseNestedNulls

Parameters

Returns void

Static_getKeyType

Parameters

Returns any

Static_loadFromCache

Parameters

Returns Promise<any>

Static_saveToCache

Parameters

Returns Promise<void>

Static_validateColumn

Parameters

Returns void

Static[custom]

`Optional` `Readonly`id

`Static`_adapter

`Static`_associations

`Static`_connection

`Static`_initialize_called

`Static`_integrities

`Static`_intermediate_paths

`Static`_name

`Static` `Optional`_object_column_classes

`Static` `Optional`_property_decorators

`Static`_schema

`Static`archive

`Static` `Optional`description

`Static`dirty_tracking

`Static`lean_query

`Static`query_record_id_as_string

`Static`table_name

`Optional`skip_log?: boolean

`Optional`transaction?: Transaction

`Optional`use_id_in_data?: boolean

`Optional`validate?: boolean

`Static`_buildSaveDataColumn

`Static`_checkConnection

`Static`_checkReady

`Static`_collapseNestedNulls

`Static`_getKeyType

`Static`_loadFromCache

`Static`_saveToCache

`Static`_validateColumn

`Static`[custom]

`Static`addValidator

`Static`afterCreate

`Static`afterDestroy

`Static`afterFind

`Static`afterInitialize

`Static`afterSave

`Static`afterUpdate

`Static`afterValidate

`Static`applyDefaultValues

`Static`beforeCreate

`Static`beforeDestroy

`Static`beforeSave

`Static`beforeUpdate

`Static`beforeValidate

`Static`belongsTo

`Static`build

`Optional`use_id_in_data?: boolean

`Static`column

`Static`connection

`Static`count

`Optional`transaction?: Transaction