Class ModelDefinition<M>

The goal of this class is to store the definition of a model.

It is part of the Repository Design Pattern. See https://github.com/sequelize/sequelize/issues/15389 for more details.

There is only one ModelDefinition instance per model per sequelize instance.

Type Parameters

M extends Model = Model

Constructors

constructor

new ModelDefinition<M extends Model<any, any> = Model<any, any>>(
    attributesOptions: ModelAttributes<M>,
    modelOptions: InitOptions<M>,
    model: ModelStatic<M>,
): ModelDefinition<M>
Type Parameters
- M extends Model<any, any> = Model<any, any>
Parameters
- attributesOptions: ModelAttributes<M>
- modelOptions: InitOptions<M>
- model: ModelStatic<M>
Returns ModelDefinition<M>
- Defined in core/src/model-definition.ts:180

Properties

`Readonly`associations

associations: {
    [associationName: string]: Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >;
} = ...

`Readonly`attributes

attributes: MapView<string, NormalizedAttributeOptions<Model<any, any>>> = ...

The list of attributes that have been normalized.

This map is fully frozen and cannot be modified directly. Modify rawAttributes then call refreshAttributes instead.

`Readonly`attributesWithGetters

attributesWithGetters: SetView<string> = ...

`Readonly`attributesWithSetters

attributesWithSetters: SetView<string> = ...

`Readonly`booleanAttributeNames

booleanAttributeNames: SetView<string> = ...

Deprecated

Code should not rely on this as users can create custom attributes.

`Readonly`columns

columns: MapView<string, NormalizedAttributeOptions<Model<any, any>>> = ...

`Readonly`dateAttributeNames

dateAttributeNames: SetView<string> = ...

Deprecated

Code should not rely on this as users can create custom attributes.

`Readonly`defaultValues

defaultValues: MapView<string, () => unknown> = ...

`Readonly`jsonAttributeNames

jsonAttributeNames: SetView<string> = ...

`Readonly`model

model: ModelStatic<M>

`Readonly`options

options: BuiltModelOptions

`Readonly`physicalAttributes

physicalAttributes: MapView<string, NormalizedAttributeOptions<Model<any, any>>> = ...

The list of attributes that actually exist in the database, as opposed to virtualAttributeNames.

`Readonly`primaryKeysAttributeNames

primaryKeysAttributeNames: SetView<string> = ...

`Readonly`rawAttributes

rawAttributes: { [attributeName: string]: AttributeOptions<M> }

The list of attributes that have not been normalized. This list can be mutated. Call refreshAttributes to update the normalized attributes ().

`Readonly`readOnlyAttributeNames

readOnlyAttributeNames: SetView<string> = ...

List of attributes that cannot be modified by the user (read-only)

`Readonly`timestampAttributeNames

timestampAttributeNames: TimestampAttributes = ...

Records which attributes are the different built-in timestamp attributes

`Readonly`virtualAttributeNames

virtualAttributeNames: SetView<string> = ...

The list of attributes that do not really exist in the database.

Accessors

autoIncrementAttributeName

get autoIncrementAttributeName(): string | null
Returns string | null
- Defined in core/src/model-definition.ts:148

hooks

get hooks(): HookHandler<ModelHooks<Model<any, any>, any>>
Returns HookHandler<ModelHooks<Model<any, any>, any>>
- Defined in core/src/model-definition.ts:176

modelName

get modelName(): string
Returns string
- Defined in core/src/model-definition.ts:163

sequelize

get sequelize(): Sequelize
Returns Sequelize
- Defined in core/src/model-definition.ts:171

table

get table(): TableNameWithSchema
Returns TableNameWithSchema
- Defined in core/src/model-definition.ts:51

underscored

get underscored(): boolean
Returns boolean
- Defined in core/src/model-definition.ts:167

versionAttributeName

get versionAttributeName(): string | undefined
Returns string | undefined
- Defined in core/src/model-definition.ts:107

Methods

getAssociation

getAssociation(
    associationPath: string | readonly string[],
):
    | Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >
    | undefined
Follows the association path and returns the association at the end of the path. For instance, say we have a model User, associated to a model Profile, associated to a model Address.

If we call User.modelDefinition.getAssociation(['profile', 'address']), we will get the association named address in the model Profile. If we call User.modelDefinition.getAssociation(['profile']), we will get the association named profile in the model User.
Parameters
- associationPath: string | readonly string[]
Returns
    | Association<
        Model<any, any>,
        Model<any, any>,
        string,
        NormalizedAssociationOptions<string>,
    >
    | undefined
- Defined in core/src/model-definition.ts:824

getColumnName

getColumnName(attributeName: string): string
Returns the column name corresponding to the given attribute name.
Parameters
- attributeName: string
Returns string
- Defined in core/src/model-definition.ts:792

getColumnNameLoose

getColumnNameLoose(attributeName: string): string
Returns the column name corresponding to the given attribute name if it exists, otherwise returns the attribute name.

⚠️ Using this method is highly discouraged. Users should specify column names & attribute names separately, to prevent any ambiguity.
Parameters
- attributeName: string
Returns string
- Defined in core/src/model-definition.ts:809

getIndexes

getIndexes(): readonly IndexOptions[]
Returns readonly IndexOptions[]
- Defined in core/src/model-definition.ts:783

isParanoid

isParanoid(): boolean
Returns boolean
- Defined in core/src/model-definition.ts:851

refreshAttributes

refreshAttributes(): void
Normalizes all attribute definitions, using rawAttributes as the source.

Returns void
- Defined in core/src/model-definition.ts:452

Class ModelDefinition<M>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ModelDefinition<M>

Properties

Readonlyassociations

Readonlyattributes

ReadonlyattributesWithGetters

ReadonlyattributesWithSetters

ReadonlybooleanAttributeNames

Deprecated

Readonlycolumns

ReadonlydateAttributeNames

Deprecated

ReadonlydefaultValues

ReadonlyjsonAttributeNames

Readonlymodel

Readonlyoptions

ReadonlyphysicalAttributes

ReadonlyprimaryKeysAttributeNames

ReadonlyrawAttributes

ReadonlyreadOnlyAttributeNames

ReadonlytimestampAttributeNames

ReadonlyvirtualAttributeNames

Accessors

autoIncrementAttributeName

Returns string | null

hooks

Returns HookHandler<ModelHooks<Model<any, any>, any>>

modelName

Returns string

sequelize

Returns Sequelize

table

Returns TableNameWithSchema

underscored

Returns boolean

versionAttributeName

Returns string | undefined

Methods

getAssociation

Parameters

Returns | Association< Model<any, any>, Model<any, any>, string, NormalizedAssociationOptions<string>, > | undefined

getColumnName

Parameters

Returns string

getColumnNameLoose

Parameters

Returns string

getIndexes

Returns readonly IndexOptions[]

isParanoid

Returns boolean

refreshAttributes

Returns void

Settings

On This Page

`Readonly`associations

`Readonly`attributes

`Readonly`attributesWithGetters

`Readonly`attributesWithSetters

`Readonly`booleanAttributeNames

`Readonly`columns

`Readonly`dateAttributeNames

`Readonly`defaultValues

`Readonly`jsonAttributeNames

`Readonly`model

`Readonly`options

`Readonly`physicalAttributes

`Readonly`primaryKeysAttributeNames

`Readonly`rawAttributes

`Readonly`readOnlyAttributeNames

`Readonly`timestampAttributeNames

`Readonly`virtualAttributeNames

Returns
| Association<
Model<any, any>,
Model<any, any>,
string,
NormalizedAssociationOptions<string>,
>
| undefined