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. 5 imports, 1 dependents.

File typescript DrizzleORM DatabaseDrivers 5 imports 1 dependents 1 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  dfefa92a_eb6b_994a_1d34_b269fb75408a["json.ts"]
  835b37b8_5537_93b3_6081_c47371e60b11["common.ts"]
  dfefa92a_eb6b_994a_1d34_b269fb75408a --> 835b37b8_5537_93b3_6081_c47371e60b11
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  dfefa92a_eb6b_994a_1d34_b269fb75408a --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  dfefa92a_eb6b_994a_1d34_b269fb75408a --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  dfefa92a_eb6b_994a_1d34_b269fb75408a --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  744f5864_8de4_6d1f_dcfc_5ef4ae408c9a["table.ts"]
  dfefa92a_eb6b_994a_1d34_b269fb75408a --> 744f5864_8de4_6d1f_dcfc_5ef4ae408c9a
  a70c1ec7_29ee_10ca_2b05_4be0c246a540["all.ts"]
  a70c1ec7_29ee_10ca_2b05_4be0c246a540 --> dfefa92a_eb6b_994a_1d34_b269fb75408a
  style dfefa92a_eb6b_994a_1d34_b269fb75408a 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 { AnySingleStoreTable } from '~/singlestore-core/table.ts';
import { SingleStoreColumn, SingleStoreColumnBuilder } from './common.ts';

export type SingleStoreJsonBuilderInitial<TName extends string> = SingleStoreJsonBuilder<{
	name: TName;
	dataType: 'json';
	columnType: 'SingleStoreJson';
	data: unknown;
	driverParam: string;
	enumValues: undefined;
	generated: undefined;
}>;

export class SingleStoreJsonBuilder<T extends ColumnBuilderBaseConfig<'json', 'SingleStoreJson'>>
	extends SingleStoreColumnBuilder<T>
{
	static override readonly [entityKind]: string = 'SingleStoreJsonBuilder';

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

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

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

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

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

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

Domain

Subdomains

Functions

Classes

Types

Dependencies

  • column-builder.ts
  • column.ts
  • common.ts
  • entity.ts
  • table.ts

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, DatabaseDrivers subdomain.
What functions are defined in json.ts?
json.ts defines 1 function(s): json.
What does json.ts depend on?
json.ts imports 5 module(s): 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/singlestore-core/columns/json.ts (domain: DrizzleORM, subdomain: DatabaseDrivers, directory: drizzle-orm/src/singlestore-core/columns).

Analyze Your Own Codebase

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

Try Supermodel Free