decimal() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 3

Entity Profile

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

Dependency Diagram

graph TD
  762c9a86_44aa_cf25_2ff8_23edb6d16846["decimal()"]
  2a9ee6c3_f2e3_0561_6981_2f8d4be67f5f["decimal.ts"]
  762c9a86_44aa_cf25_2ff8_23edb6d16846 -->|defined in| 2a9ee6c3_f2e3_0561_6981_2f8d4be67f5f
  5932fd6a_6afc_0e21_8fee_3c3ec75a21b0["getSQLType()"]
  5932fd6a_6afc_0e21_8fee_3c3ec75a21b0 -->|calls| 762c9a86_44aa_cf25_2ff8_23edb6d16846
  52aed0ca_cedf_acc7_dd2f_ea9c3471207d["getSQLType()"]
  52aed0ca_cedf_acc7_dd2f_ea9c3471207d -->|calls| 762c9a86_44aa_cf25_2ff8_23edb6d16846
  ac0478db_f1e5_a98d_8457_8fc76a1fda59["getSQLType()"]
  ac0478db_f1e5_a98d_8457_8fc76a1fda59 -->|calls| 762c9a86_44aa_cf25_2ff8_23edb6d16846
  style 762c9a86_44aa_cf25_2ff8_23edb6d16846 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/columns/decimal.ts lines 214–222

export function decimal(a?: string | SingleStoreDecimalConfig, b: SingleStoreDecimalConfig = {}) {
	const { name, config } = getColumnNameAndConfig<SingleStoreDecimalConfig>(a, b);
	const mode = config?.mode;
	return mode === 'number'
		? new SingleStoreDecimalNumberBuilder(name, config)
		: mode === 'bigint'
		? new SingleStoreDecimalBigIntBuilder(name, config)
		: new SingleStoreDecimalBuilder(name, config);
}