geometry.ts — drizzle-orm Source File
Architecture documentation for geometry.ts, a typescript file in the drizzle-orm codebase. 9 imports, 1 dependents.
Entity Profile
Dependency Diagram
graph LR 22ef1bda_02be_c80a_be3e_7a9614a5f2f9["geometry.ts"] f4f42b4c_8610_03dd_fe01_232098668127["common.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> f4f42b4c_8610_03dd_fe01_232098668127 099d7c6d_2fc4_7b20_40e3_1b8af4138fe6["PgColumn"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 099d7c6d_2fc4_7b20_40e3_1b8af4138fe6 2fd88d3d_d232_1908_a500_f72815cd371a["utils.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 2fd88d3d_d232_1908_a500_f72815cd371a 7148fb50_625b_76f3_0dcf_98a75f034468["parseEWKB"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 7148fb50_625b_76f3_0dcf_98a75f034468 2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426 05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2 27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426 17418917_ff81_c4e5_90f4_f37d557e5d51["table.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> 17418917_ff81_c4e5_90f4_f37d557e5d51 ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"] 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 --> ecce3253_1e75_a87f_27b3_ca87e81a3024 b38cf654_48d6_41dc_6c0f_203697984d98["all.ts"] b38cf654_48d6_41dc_6c0f_203697984d98 --> 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 style 22ef1bda_02be_c80a_be3e_7a9614a5f2f9 fill:#6366f1,stroke:#818cf8,color:#fff
Relationship Graph
Source Code
import type { ColumnBuilderBaseConfig, ColumnBuilderRuntimeConfig, MakeColumnConfig } from '~/column-builder.ts';
import type { ColumnBaseConfig } from '~/column.ts';
import { entityKind } from '~/entity.ts';
import type { AnyPgTable } from '~/pg-core/table.ts';
import { type Equal, getColumnNameAndConfig } from '~/utils.ts';
import { PgColumn, PgColumnBuilder } from '../common.ts';
import { parseEWKB } from './utils.ts';
export type PgGeometryBuilderInitial<TName extends string> = PgGeometryBuilder<{
name: TName;
dataType: 'array';
columnType: 'PgGeometry';
data: [number, number];
driverParam: string;
enumValues: undefined;
}>;
export class PgGeometryBuilder<T extends ColumnBuilderBaseConfig<'array', 'PgGeometry'>> extends PgColumnBuilder<T> {
static override readonly [entityKind]: string = 'PgGeometryBuilder';
constructor(name: T['name']) {
super(name, 'array', 'PgGeometry');
}
/** @internal */
override build<TTableName extends string>(
table: AnyPgTable<{ name: TTableName }>,
): PgGeometry<MakeColumnConfig<T, TTableName>> {
return new PgGeometry<MakeColumnConfig<T, TTableName>>(
table,
this.config as ColumnBuilderRuntimeConfig<any, any>,
);
}
}
export class PgGeometry<T extends ColumnBaseConfig<'array', 'PgGeometry'>> extends PgColumn<T> {
static override readonly [entityKind]: string = 'PgGeometry';
getSQLType(): string {
return 'geometry(point)';
}
override mapFromDriverValue(value: string): [number, number] {
return parseEWKB(value);
}
override mapToDriverValue(value: [number, number]): string {
return `point(${value[0]} ${value[1]})`;
}
}
export type PgGeometryObjectBuilderInitial<TName extends string> = PgGeometryObjectBuilder<{
name: TName;
dataType: 'json';
columnType: 'PgGeometryObject';
data: { x: number; y: number };
driverParam: string;
enumValues: undefined;
}>;
export class PgGeometryObjectBuilder<T extends ColumnBuilderBaseConfig<'json', 'PgGeometryObject'>>
extends PgColumnBuilder<T>
{
static override readonly [entityKind]: string = 'PgGeometryObjectBuilder';
constructor(name: T['name']) {
super(name, 'json', 'PgGeometryObject');
}
/** @internal */
override build<TTableName extends string>(
table: AnyPgTable<{ name: TTableName }>,
): PgGeometryObject<MakeColumnConfig<T, TTableName>> {
return new PgGeometryObject<MakeColumnConfig<T, TTableName>>(
table,
this.config as ColumnBuilderRuntimeConfig<any, any>,
);
}
}
export class PgGeometryObject<T extends ColumnBaseConfig<'json', 'PgGeometryObject'>> extends PgColumn<T> {
static override readonly [entityKind]: string = 'PgGeometryObject';
getSQLType(): string {
return 'geometry(point)';
}
override mapFromDriverValue(value: string): { x: number; y: number } {
const parsed = parseEWKB(value);
return { x: parsed[0], y: parsed[1] };
}
override mapToDriverValue(value: { x: number; y: number }): string {
return `point(${value.x} ${value.y})`;
}
}
export interface PgGeometryConfig<T extends 'tuple' | 'xy' = 'tuple' | 'xy'> {
mode?: T;
type?: 'point' | (string & {});
srid?: number;
}
export function geometry(): PgGeometryBuilderInitial<''>;
export function geometry<TMode extends PgGeometryConfig['mode'] & {}>(
config?: PgGeometryConfig<TMode>,
): Equal<TMode, 'xy'> extends true ? PgGeometryObjectBuilderInitial<''> : PgGeometryBuilderInitial<''>;
export function geometry<TName extends string, TMode extends PgGeometryConfig['mode'] & {}>(
name: TName,
config?: PgGeometryConfig<TMode>,
): Equal<TMode, 'xy'> extends true ? PgGeometryObjectBuilderInitial<TName> : PgGeometryBuilderInitial<TName>;
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);
}
Domain
Subdomains
Functions
Imported By
Source
Frequently Asked Questions
What does geometry.ts do?
geometry.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, DatabaseDrivers subdomain.
What functions are defined in geometry.ts?
geometry.ts defines 1 function(s): geometry.
What does geometry.ts depend on?
geometry.ts imports 9 module(s): PgColumn, column-builder.ts, column.ts, common.ts, entity.ts, parseEWKB, table.ts, utils.ts, and 1 more.
What files import geometry.ts?
geometry.ts is imported by 1 file(s): all.ts.
Where is geometry.ts in the architecture?
geometry.ts is located at drizzle-orm/src/pg-core/columns/postgis_extension/geometry.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/pg-core/columns/postgis_extension).
Analyze Your Own Codebase
Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.
Try Supermodel Free