Documentation
    Preparing search index...

    Interface NormalizedAttributeOptions<M>

    interface NormalizedAttributeOptions<M extends Model = Model> {
        allowNull?: boolean;
        attributeName: string;
        autoIncrement?: boolean;
        autoIncrementIdentity?: boolean;
        columnName: string;
        comment?: string;
        defaultValue?: unknown;
        field?: string;
        fieldName: string;
        get?: (this: M) => unknown;
        onDelete?: ReferentialAction;
        onUpdate?: ReferentialAction;
        primaryKey?: boolean;
        references?: NormalizedAttributeReferencesOptions;
        set?: (this: M, val: any) => void;
        type: NormalizedDataType;
        validate?: ColumnValidateOptions;
    }

    Type Parameters

    Hierarchy

    Index
    allowNull? attributeName autoIncrement? autoIncrementIdentity? columnName comment? defaultValue? field? fieldName get? onDelete? onUpdate? primaryKey? references? set? type validate?
    allowNull?: boolean

    If false, the column will have a NOT NULL constraint, and a not null validation will be run before an instance is saved.

    true
    attributeName: string

    The name of the attribute (JS side).

    autoIncrement?: boolean

    Is this field an auto increment field

    autoIncrementIdentity?: boolean

    If this field is a Postgres auto increment field, use Postgres GENERATED BY DEFAULT AS IDENTITY instead of SERIAL. Postgres 10+ only.

    columnName: string

    The name of the column.

    If no value is provided, Sequelize will use the name of the attribute (in snake_case if InitOptions.underscored is true)

    comment?: string

    Comment to add on the column in the database.

    defaultValue?: unknown

    A literal default value, a JavaScript function, or an SQL function (using @sequelize/core!sql.fn)

    field?: string

    use columnName instead.

    fieldName: string

    use NormalizedAttributeOptions.attributeName instead.

    get?: (this: M) => unknown

    Provide a custom getter for this column. Use Model.getDataValue to access the underlying values.

    onDelete?: ReferentialAction

    What should happen when the referenced key is deleted. One of CASCADE, RESTRICT, SET DEFAULT, SET NULL or NO ACTION

    onUpdate?: ReferentialAction

    What should happen when the referenced key is updated. One of CASCADE, RESTRICT, SET DEFAULT, SET NULL or NO ACTION

    primaryKey?: boolean

    If true, this attribute will be marked as primary key

    references?: NormalizedAttributeReferencesOptions

    Makes this attribute a foreign key. You typically don't need to use this yourself, instead use associations.

    Setting this value to a string equivalent to setting it to { tableName: 'myString' }.

    set?: (this: M, val: any) => void

    Provide a custom setter for this column. Use Model.setDataValue to access the underlying values.

    type: NormalizedDataType

    Like AttributeOptions.type, but normalized.

    validate?: ColumnValidateOptions

    An object of validations to execute for this column every time the model is saved. Can be either the name of a validation provided by validator.js, a validation function provided by extending validator.js (see the DAOValidator property for more details), or a custom validation function. Custom validation functions are called with the value of the field, and can possibly take a second callback argument, to signal that they are asynchronous. If the validator is sync, it should throw in the case of a failed validation, it is async, the callback should be called with the error text.

    Settings
    Member Visibility

    On This Page
    Properties