Class BaseModel

Base class for models

Index

Constructors

constructor

Constructors

constructor

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

Properties

`Private` `Optional` _attributes

_attributes?: any

`Private` `Optional` _intermediates

_intermediates?: any

`Private` `Optional` _is_persisted

_is_persisted?: any

`Private` `Optional` _prev_attributes

_prev_attributes?: any

`Optional` `Readonly` id

id?: any

`Static` _adapter

_adapter: AdapterBase

Indicates the adapter associated to this model

`Static` _associations

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

Type declaration

[column: string]: any

`Static` `Private` `Optional` _callbacks_map

_callbacks_map?: {
    create: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    destroy: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    find: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    initialize: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    save: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    update: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
    validate: undefined | {
        method: ModelCallbackMethod;
        type: ModelCallbackType;
    }[];
}

Type declaration

create: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
destroy: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
find: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
initialize: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
save: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
update: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]
validate: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

`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;
}[]

Type declaration

Optional child?: typeof BaseModel
column: string
Optional 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;
}[]

Type declaration

column: string
klass: any

`Static` `Optional` _property_decorators

_property_decorators?: any[]

`Static` _schema

_schema: ModelSchemaInternal

`Static` `Private` _validators

_validators: any[]

`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

`Private` _buildSaveData

_buildSaveData(): any
Returns any
- Defined in packages/cormo/src/model/index.ts:1256

`Private` _create

_create(options): Promise<{}>
Parameters
- options: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data?: boolean;
  }
  - Optional skip_log?: boolean
  - Optional transaction?: Transaction
  - Optional use_id_in_data?: boolean
Returns Promise<{}>
- Defined in packages/cormo/src/model/index.ts:1273

_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:1146

`Private` _runCallbacks

_runCallbacks(name, type): void
Parameters
- name: ModelCallbackName
- type: ModelCallbackType
Returns void
- Defined in packages/cormo/src/model/index.ts:1234

`Private` _update

_update(options): Promise<undefined | {}>
Parameters
- options: {
  skip_log?: boolean;
  transaction?: Transaction;
  }
  - Optional skip_log?: boolean
  - Optional transaction?: Transaction
Returns Promise<undefined | {}>
- Defined in packages/cormo/src/model/index.ts:1312

destroy

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

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

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:1073

getChanged

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

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

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:1084

isDirty

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

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

reset

reset(): void
Resets all changes

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

save

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

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:1091

validate

validate(): void
Validates data

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

`Static` [custom]

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

`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` `Private` _createBulk

_createBulk(records, options?): Promise<any[]>
Parameters
- records: any[]
- options: {
  transaction?: Transaction;
  use_id_in_data?: boolean;
  } = {}
  - Optional transaction?: Transaction
  - Optional use_id_in_data?: boolean
Returns Promise<any[]>
- Defined in packages/cormo/src/model/index.ts:888

`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
- Optional refresh: 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` `Private` _validateType

_validateType(column, type_class, value): any
Parameters
- column: any
- type_class: any
- value: any
Returns any
- Defined in packages/cormo/src/model/index.ts:919

`Static` `Private` addCallback

addCallback(type, name, method): number
Adds a callback
Parameters
- type: ModelCallbackType
- name: ModelCallbackName
- method: ModelCallbackMethod
Returns number
- Defined in packages/cormo/src/model/index.ts:881

`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:1344

`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
- Optional options: 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?) => M)
  - - new (data_arg?): M
    - Parameters
      Optional data_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?) => M)
  - - new (data_arg?): M
    - Parameters
      Optional data_arg: any
      Returns M
- Optional data: ModelValueObject<M>
- Optional options: {
  use_id_in_data?: boolean;
  }
  - Optional use_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>
- Optional name: string
Returns void
- Defined in packages/cormo/src/model/index.ts:176

`Static` count

count(condition?, options?): Promise<number>
Counts records by conditions
Parameters
- Optional condition: object
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- data: ModelValueObjectWithId<M>
- options: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data: true;
  }
  - Optional skip_log?: boolean
  - Optional transaction?: 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?) => M) & typeof BaseModel
- Optional data: ModelValueObject<M>
- Optional options: {
      skip_log?: boolean;
      transaction?: Transaction;
      use_id_in_data?: boolean;
  }
  - Optional skip_log?: boolean
  - Optional transaction?: Transaction
  - Optional use_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?) => M) & typeof BaseModel
- data: ModelValueObjectWithId<M>[]
- options: {
  transaction?: Transaction;
  use_id_in_data: true;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- Optional data: ModelValueObject<M>[]
- Optional options: {
  transaction?: Transaction;
  use_id_in_data?: boolean;
  }
  - Optional transaction?: Transaction
  - Optional use_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
- Optional condition: object
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- id: CormoTypesRecordID
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- id: CormoTypesRecordID[]
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- ids: CormoTypesRecordID[]
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- group_by: G | G[]
- Optional fields: F
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- group_by: null
- Optional fields: F
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- group_by: null | string
- Optional fields: object
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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
- Optional options: 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
- Optional options: 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;
  } = {}
  - Optional name?: string
  - Optional unique?: 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?) => M) & typeof BaseModel
- orders: string
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- columns: K[]
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- Optional columns: string
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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
- Optional condition: object
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: 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?) => M) & typeof BaseModel
- Optional condition: object
- Optional options: {
  transaction?: Transaction;
  }
  - Optional transaction?: Transaction
Returns QueryArray<M, M>
- Defined in packages/cormo/src/model/index.ts:668

Class BaseModel

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional data: object

Returns BaseModel

Properties

Private Optional _attributes

Private Optional _intermediates

Private Optional _is_persisted

Private Optional _prev_attributes

Optional Readonly id

Static _adapter

Static _associations

Type declaration

[column: string]: any

Static Private Optional _callbacks_map

Type declaration

create: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

destroy: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

find: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

initialize: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

save: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

update: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

validate: undefined | { method: ModelCallbackMethod; type: ModelCallbackType; }[]

Static _connection

Static _initialize_called

Static _integrities

Type declaration

Optional child?: typeof BaseModel

column: string

Optional parent?: typeof BaseModel

type: string

Static _intermediate_paths

Static _name

Static Optional _object_column_classes

Type declaration

column: string

klass: any

Static Optional _property_decorators

Static _schema

Static Private _validators

Static archive

Static Optional description

Static dirty_tracking

Static lean_query

Static query_record_id_as_string

Static table_name

Methods

Private _buildSaveData

Returns any

Private _create

Parameters

options: { skip_log?: boolean; transaction?: Transaction; use_id_in_data?: boolean; }

Optional skip_log?: boolean

Optional transaction?: Transaction

Optional use_id_in_data?: boolean

Returns Promise<{}>

_defineProperty

Parameters

object: any

key: any

path: any

enumerable: any

Returns void

Private _runCallbacks

Parameters

name: ModelCallbackName

type: ModelCallbackType

Returns void

Private _update

Parameters

options: { skip_log?: boolean; transaction?: Transaction; }

Optional skip_log?: boolean

Optional transaction?: Transaction

Returns Promise<undefined | {}>

`Optional` data: object

`Private` `Optional` _attributes

`Private` `Optional` _intermediates

`Private` `Optional` _is_persisted

`Private` `Optional` _prev_attributes

`Optional` `Readonly` id

`Static` _adapter

`Static` _associations

`Static` `Private` `Optional` _callbacks_map

create: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

destroy: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

find: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

initialize: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

save: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

update: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

validate: undefined | {
method: ModelCallbackMethod;
type: ModelCallbackType;
}[]

`Static` _connection

`Static` _initialize_called

`Static` _integrities

`Optional` child?: typeof BaseModel

`Optional` parent?: typeof BaseModel

`Static` _intermediate_paths

`Static` _name

`Static` `Optional` _object_column_classes

`Static` `Optional` _property_decorators

`Static` _schema

`Static` `Private` _validators

`Static` archive

`Static` `Optional` description

`Static` dirty_tracking

`Static` lean_query

`Static` query_record_id_as_string

`Static` table_name

`Private` _buildSaveData

`Private` _create

options: {
skip_log?: boolean;
transaction?: Transaction;
use_id_in_data?: boolean;
}

`Optional` skip_log?: boolean

`Optional` transaction?: Transaction

`Optional` use_id_in_data?: boolean

`Private` _runCallbacks

`Private` _update

options: {
skip_log?: boolean;
transaction?: Transaction;
}

`Optional` skip_log?: boolean

`Optional` transaction?: Transaction

options: {
skip_log?: boolean;
transaction?: Transaction;
use_id_in_data?: boolean;
validate?: boolean;
} = {}

`Optional` skip_log?: boolean

`Optional` transaction?: Transaction

`Optional` use_id_in_data?: boolean

`Optional` validate?: boolean

`Static` [custom]

`Static` _buildSaveDataColumn

`Static` _checkConnection

`Static` _checkReady

`Static` _collapseNestedNulls

`Static` `Private` _createBulk

options: {
transaction?: Transaction;
use_id_in_data?: boolean;
} = {}

`Optional` transaction?: Transaction

`Optional` use_id_in_data?: boolean

`Static` _getKeyType

`Static` _loadFromCache

`Optional` refresh: boolean

`Static` _saveToCache