geometry() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers called by 2

Entity Profile

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

Dependency Diagram

graph TD
  02c307e9_1ee1_fe27_db39_b74272cc9f16["geometry()"]
  22ef1bda_02be_c80a_be3e_7a9614a5f2f9["geometry.ts"]
  02c307e9_1ee1_fe27_db39_b74272cc9f16 -->|defined in| 22ef1bda_02be_c80a_be3e_7a9614a5f2f9
  edcf8146_57b5_877d_9b93_cd8c329c1730["getSQLType()"]
  edcf8146_57b5_877d_9b93_cd8c329c1730 -->|calls| 02c307e9_1ee1_fe27_db39_b74272cc9f16
  51ff8923_7211_35e8_ba9d_f7c7c6b939d2["getSQLType()"]
  51ff8923_7211_35e8_ba9d_f7c7c6b939d2 -->|calls| 02c307e9_1ee1_fe27_db39_b74272cc9f16
  style 02c307e9_1ee1_fe27_db39_b74272cc9f16 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/columns/postgis_extension/geometry.ts lines 113–119

export function geometry(a?: string | PgGeometryConfig, b?: PgGeometryConfig) {
	const { name, config } = getColumnNameAndConfig<PgGeometryConfig>(a, b);
	if (!config?.mode || config.mode === 'tuple') {
		return new PgGeometryBuilder(name);
	}
	return new PgGeometryObjectBuilder(name);
}