drizzle-orm Architecture Docs
Home / File/ utils.ts — drizzle-orm Source File

utils.ts — drizzle-orm Source File

Architecture documentation for utils.ts, a typescript file in the drizzle-orm codebase. 4 imports, 4 dependents.

File typescript ValidationAdapters TypeMapping 4 imports 4 dependents 3 functions

Entity Profile

Dependency Diagram

graph LR
  6926d326_babb_b38d_98de_f0d261e6df93["utils.ts"]
  03d2f7f9_4592_2641_ed27_5e125e89d737["column.ts"]
  6926d326_babb_b38d_98de_f0d261e6df93 --> 03d2f7f9_4592_2641_ed27_5e125e89d737
  4859a2e0_4bd3_506a_e7e6_bf4316983bb5["arktype"]
  6926d326_babb_b38d_98de_f0d261e6df93 --> 4859a2e0_4bd3_506a_e7e6_bf4316983bb5
  690f7dfc_0aea_9ee8_d6e7_26bbb3689031["drizzle-orm"]
  6926d326_babb_b38d_98de_f0d261e6df93 --> 690f7dfc_0aea_9ee8_d6e7_26bbb3689031
  53497908_16e7_977d_e97d_7414884a88a6["pg-core"]
  6926d326_babb_b38d_98de_f0d261e6df93 --> 53497908_16e7_977d_e97d_7414884a88a6
  03d2f7f9_4592_2641_ed27_5e125e89d737["column.ts"]
  03d2f7f9_4592_2641_ed27_5e125e89d737 --> 6926d326_babb_b38d_98de_f0d261e6df93
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a["column.types.ts"]
  2c5e5814_b2ae_7e07_7c6b_6bb520b5f82a --> 6926d326_babb_b38d_98de_f0d261e6df93
  b3de3d3d_2c66_6c17_9e29_4ae6af2ae68f["schema.ts"]
  b3de3d3d_2c66_6c17_9e29_4ae6af2ae68f --> 6926d326_babb_b38d_98de_f0d261e6df93
  d530d59d_be0a_6412_1cd0_197b9709fc36["schema.types.internal.ts"]
  d530d59d_be0a_6412_1cd0_197b9709fc36 --> 6926d326_babb_b38d_98de_f0d261e6df93
  style 6926d326_babb_b38d_98de_f0d261e6df93 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type { type } from 'arktype';
import type { Column, SelectedFieldsFlat, Table, View } from 'drizzle-orm';
import type { PgEnum } from 'drizzle-orm/pg-core';
import type { literalSchema } from './column.ts';

export function isColumnType<T extends Column>(column: Column, columnTypes: string[]): column is T {
	return columnTypes.includes(column.columnType);
}

export function isWithEnum(column: Column): column is typeof column & { enumValues: [string, ...string[]] } {
	return 'enumValues' in column && Array.isArray(column.enumValues) && column.enumValues.length > 0;
}

export const isPgEnum: (entity: any) => entity is PgEnum<[string, ...string[]]> = isWithEnum as any;

type Literal = type.infer<typeof literalSchema>;
export type Json = Literal | Record<string, any> | any[];

export type ColumnIsGeneratedAlwaysAs<TColumn> = TColumn extends Column
	? TColumn['_']['identity'] extends 'always' ? true
	: TColumn['_']['generated'] extends { type: 'byDefault' } | undefined ? false
	: true
	: false;

export type GetSelection<T extends SelectedFieldsFlat<Column> | Table | View> = T extends Table ? T['_']['columns']
	: T extends View ? T['_']['selectedFields']
	: T;

Domain

Subdomains

Functions

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does utils.ts do?
utils.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the ValidationAdapters domain, TypeMapping subdomain.
What functions are defined in utils.ts?
utils.ts defines 3 function(s): entity, isColumnType, isWithEnum.
What does utils.ts depend on?
utils.ts imports 4 module(s): arktype, column.ts, drizzle-orm, pg-core.
What files import utils.ts?
utils.ts is imported by 4 file(s): column.ts, column.types.ts, schema.ts, schema.types.internal.ts.
Where is utils.ts in the architecture?
utils.ts is located at drizzle-arktype/src/utils.ts (domain: ValidationAdapters, subdomain: TypeMapping, directory: drizzle-arktype/src).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free