decimal() — drizzle-orm Function Reference

Architecture documentation for the decimal() function in decimal.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects called by 3

Entity Profile

DrizzleORM→ SQLDialects→ decimal() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  08efdd8b_966e_421b_c5a8_3278f05e2c69["decimal()"]
  1cab2e69_931d_80bd_c0f4_f9093012117e["decimal.ts"]
  08efdd8b_966e_421b_c5a8_3278f05e2c69 -->|defined in| 1cab2e69_931d_80bd_c0f4_f9093012117e
  4cea38f9_e736_525e_4b7f_fb2aaa05b336["getSQLType()"]
  4cea38f9_e736_525e_4b7f_fb2aaa05b336 -->|calls| 08efdd8b_966e_421b_c5a8_3278f05e2c69
  f9f168e6_6b8d_79e9_3e77_4b19718c9391["getSQLType()"]
  f9f168e6_6b8d_79e9_3e77_4b19718c9391 -->|calls| 08efdd8b_966e_421b_c5a8_3278f05e2c69
  0d5a1ead_463a_9ac7_3362_784b8e622437["getSQLType()"]
  0d5a1ead_463a_9ac7_3362_784b8e622437 -->|calls| 08efdd8b_966e_421b_c5a8_3278f05e2c69
  style 08efdd8b_966e_421b_c5a8_3278f05e2c69 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/columns/decimal.ts lines 210–218

export function decimal(a?: string | MySqlDecimalConfig, b: MySqlDecimalConfig = {}) {
	const { name, config } = getColumnNameAndConfig<MySqlDecimalConfig>(a, b);
	const mode = config?.mode;
	return mode === 'number'
		? new MySqlDecimalNumberBuilder(name, config)
		: mode === 'bigint'
		? new MySqlDecimalBigIntBuilder(name, config)
		: new MySqlDecimalBuilder(name, config);
}