numeric() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 3

Entity Profile

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

Dependency Diagram

graph TD
  bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7["numeric()"]
  b02d9686_b68f_1cdd_74bf_e7c79bb754fb["numeric.ts"]
  bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7 -->|defined in| b02d9686_b68f_1cdd_74bf_e7c79bb754fb
  aa7e25ab_74d3_4171_5aee_d962d5c777e0["getSQLType()"]
  aa7e25ab_74d3_4171_5aee_d962d5c777e0 -->|calls| bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7
  7af7fc36_c26b_0055_0c91_d178b1fbfed4["getSQLType()"]
  7af7fc36_c26b_0055_0c91_d178b1fbfed4 -->|calls| bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7
  a24bfd56_d9b3_ef51_1ea6_63c46659103c["getSQLType()"]
  a24bfd56_d9b3_ef51_1ea6_63c46659103c -->|calls| bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7
  style bb29d8f1_017a_7d6e_0c9f_e38ed2c355f7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/numeric.ts lines 217–225

export function numeric(a?: string | PgNumericConfig, b?: PgNumericConfig) {
	const { name, config } = getColumnNameAndConfig<PgNumericConfig>(a, b);
	const mode = config?.mode;
	return mode === 'number'
		? new PgNumericNumberBuilder(name, config?.precision, config?.scale)
		: mode === 'bigint'
		? new PgNumericBigIntBuilder(name, config?.precision, config?.scale)
		: new PgNumericBuilder(name, config?.precision, config?.scale);
}