Class DECIMAL

constructor

• new DECIMAL(
      precisionOrOptions?:
          | number
          | { precision?: number; scale?: number; unsigned?: boolean },
      scale?: number,
      unsigned?: boolean,
  ): DECIMAL

  Create a DECIMAL data type

  Parameters

  • OptionalprecisionOrOptions: number | { precision?: number; scale?: number; unsigned?: boolean }

    Either precision number or an options object

  • scale: number = 0

    Number of decimal places (when precision is a number)

  • unsigned: boolean = false

    Whether the value is unsigned

  Returns DECIMAL

  Example

  // DECIMAL with default precision (10, 0)
  DataTypes.DECIMAL()
  // DECIMAL with precision only (scale defaults to 0)
  DataTypes.DECIMAL(10)
  // DECIMAL with precision and scale
  DataTypes.DECIMAL(10, 2)
  // DECIMAL with options object
  DataTypes.DECIMAL({ precision: 10, scale: 2, unsigned: true })
  Copy

key

precision

scale

Optionalunsigned

toSqlString

• toSqlString(dialect?: string): string

  Parameters

  • Optionaldialect: string

  Returns string