Documentation
    Preparing search index...

    Class DECIMAL

    Arbitrary/exact precision decimal number.

    Fallback policy:

    • If the precision or scale options are unsupported by the dialect, they will be ignored.
    • If the precision or scale options are not specified, and the dialect does not support unconstrained decimals, an error will be raised.
    • If the zerofill option is unsupported by the dialect, an error will be raised.
    • If the unsigned option is unsupported, it will be replaced by a CHECK > 0 constraint.
    DataTypes.DECIMAL

    Hierarchy (View Summary)

    Index
    constructor
    options usageContext
    UNSIGNED ZEROFILL UNSIGNED ZEROFILL
    _checkOptionSupport _construct _getDialect _supportsNativeUnsigned acceptsNull areValuesEqual belongsToDialect clone escape getBindParamSql getDataTypeId getNumberSqlTypeName isUnconstrained parseDatabaseValue sanitize toBindableValue toDialectDataType toSql toString validate withUsageContext getDataTypeId toString
    options: DecimalNumberOptions
    usageContext: DataTypeUseContext | undefined

    Where this DataType is being used.

    • get UNSIGNED(): this

      Returns this

    • get ZEROFILL(): this

      Returns this

    • get UNSIGNED(): BaseNumberDataType<{ unsigned: true }>

      Returns BaseNumberDataType<{ unsigned: true }>

    • get ZEROFILL(): BaseNumberDataType<{ zerofill: true }>

      Returns BaseNumberDataType<{ zerofill: true }>

    Protected_checkOptionSupport

    • _checkOptionSupport(dialect: AbstractDialect): void

      Override this method to emit an error or a warning if the Data Type, as it is configured, is not compatible with the current dialect.

      Parameters

      Returns void

    Protected_construct

    Protected_getDialect

    Protected_supportsNativeUnsigned

    • Whether this DataType wishes to handle NULL values itself. This is almost exclusively used by JSON and JSONB which serialize null as the JSON string 'null'.

      Returns boolean

    • Returns a copy of this DataType, without usage context. Designed to re-use a DataType on another Model.

      Returns this

    • Escapes a value for the purposes of inlining it in a SQL query. The resulting value will be inlined as-is with no further escaping.

      Parameters

      Returns string

    • This method is called when AbstractQueryGenerator needs to add a bind parameter to a query it is building. This method allows for customizing both the SQL to add to the query, and convert the bind parameter value to a DB-compatible value.

      If you only need to prepare the bind param value, implement toBindableValue instead.

      This method must return the SQL to add to the query. You can obtain a bind parameter ID by calling BindParamOptions#bindParam with the value associated to that bind parameter.

      An example of a data type that requires customizing the SQL is the GEOMETRY data type.

      Parameters

      Returns string

    • Called when a value is retrieved from the Database, and its DataType is specified. Used to normalize values from the database.

      Note: It is also possible to do an initial parsing of a Database value using AbstractDialect#registerDataTypeParser. That normalization uses the type ID from the database instead of a Sequelize Data Type to determine which parser to use, and is called before this method.

      Parameters

      • value: unknown

        The value to parse.

      Returns unknown

    • Converts a JS value to a value compatible with the connector library for this Data Type. Unlike escape, this value does not need to be escaped. It is passed separately to the database, which will handle escaping.

      Parameters

      Returns string | number

    • Returns a SQL declaration of this data type. e.g. 'VARCHAR(255)', 'TEXT', etc…

      Returns string

    • Checks whether the JS value is compatible with (or can be converted to) the SQL data type. Throws if that is not the case.

      Parameters

      • value: any

      Returns asserts value is AcceptedNumber

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods