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

json.ts — drizzle-orm Source File

Architecture documentation for json.ts, a typescript file in the drizzle-orm codebase. 6 imports, 1 dependents.

File typescript DrizzleORM SQLDialects 6 imports 1 dependents 1 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  8939ff95_60dc_5104_301e_964a9362fe4e["json.ts"]
  83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb["common.ts"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb
  8da43de9_1be1_48fb_1db1_a6bc59f5b306["MySqlColumn"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 8da43de9_1be1_48fb_1db1_a6bc59f5b306
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  70e1783e_f575_ccd4_36bd_5f0978c2172c["table.ts"]
  8939ff95_60dc_5104_301e_964a9362fe4e --> 70e1783e_f575_ccd4_36bd_5f0978c2172c
  6dd15b44_b15c_62ef_81b2_e72b28299be9["all.ts"]
  6dd15b44_b15c_62ef_81b2_e72b28299be9 --> 8939ff95_60dc_5104_301e_964a9362fe4e
  style 8939ff95_60dc_5104_301e_964a9362fe4e 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 { AnyMySqlTable } from '~/mysql-core/table.ts';
import { MySqlColumn, MySqlColumnBuilder } from './common.ts';

export type MySqlJsonBuilderInitial<TName extends string> = MySqlJsonBuilder<{
	name: TName;
	dataType: 'json';
	columnType: 'MySqlJson';
	data: unknown;
	driverParam: string;
	enumValues: undefined;
}>;

export class MySqlJsonBuilder<T extends ColumnBuilderBaseConfig<'json', 'MySqlJson'>> extends MySqlColumnBuilder<T> {
	static override readonly [entityKind]: string = 'MySqlJsonBuilder';

	constructor(name: T['name']) {
		super(name, 'json', 'MySqlJson');
	}

	/** @internal */
	override build<TTableName extends string>(
		table: AnyMySqlTable<{ name: TTableName }>,
	): MySqlJson<MakeColumnConfig<T, TTableName>> {
		return new MySqlJson<MakeColumnConfig<T, TTableName>>(table, this.config as ColumnBuilderRuntimeConfig<any, any>);
	}
}

export class MySqlJson<T extends ColumnBaseConfig<'json', 'MySqlJson'>> extends MySqlColumn<T> {
	static override readonly [entityKind]: string = 'MySqlJson';

	getSQLType(): string {
		return 'json';
	}

	override mapToDriverValue(value: T['data']): string {
		return JSON.stringify(value);
	}
}

export function json(): MySqlJsonBuilderInitial<''>;
export function json<TName extends string>(name: TName): MySqlJsonBuilderInitial<TName>;
export function json(name?: string) {
	return new MySqlJsonBuilder(name ?? '');
}

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does json.ts do?
json.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, SQLDialects subdomain.
What functions are defined in json.ts?
json.ts defines 1 function(s): json.
What does json.ts depend on?
json.ts imports 6 module(s): MySqlColumn, column-builder.ts, column.ts, common.ts, entity.ts, table.ts.
What files import json.ts?
json.ts is imported by 1 file(s): all.ts.
Where is json.ts in the architecture?
json.ts is located at drizzle-orm/src/mysql-core/columns/json.ts (domain: DrizzleORM, subdomain: SQLDialects, directory: drizzle-orm/src/mysql-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free