varchar.ts — drizzle-orm Source File
Architecture documentation for varchar.ts, a typescript file in the drizzle-orm codebase. 6 imports, 1 dependents.
Entity Profile
Dependency Diagram
graph LR b32666fb_b5e4_6ca4_5526_bced2750e0e1["varchar.ts"] 835b37b8_5537_93b3_6081_c47371e60b11["common.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> 835b37b8_5537_93b3_6081_c47371e60b11 2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426 05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2 27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426 744f5864_8de4_6d1f_dcfc_5ef4ae408c9a["table.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> 744f5864_8de4_6d1f_dcfc_5ef4ae408c9a ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"] b32666fb_b5e4_6ca4_5526_bced2750e0e1 --> ecce3253_1e75_a87f_27b3_ca87e81a3024 a70c1ec7_29ee_10ca_2b05_4be0c246a540["all.ts"] a70c1ec7_29ee_10ca_2b05_4be0c246a540 --> b32666fb_b5e4_6ca4_5526_bced2750e0e1 style b32666fb_b5e4_6ca4_5526_bced2750e0e1 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 { getColumnNameAndConfig, type Writable } from '~/utils.ts';
import { SingleStoreColumn, SingleStoreColumnBuilder } from './common.ts';
export type SingleStoreVarCharBuilderInitial<
TName extends string,
TEnum extends [string, ...string[]],
TLength extends number | undefined,
> = SingleStoreVarCharBuilder<
{
name: TName;
dataType: 'string';
columnType: 'SingleStoreVarChar';
data: TEnum[number];
driverParam: number | string;
enumValues: TEnum;
generated: undefined;
length: TLength;
}
>;
export class SingleStoreVarCharBuilder<
T extends ColumnBuilderBaseConfig<'string', 'SingleStoreVarChar'> & { length?: number | undefined },
> extends SingleStoreColumnBuilder<T, SingleStoreVarCharConfig<T['enumValues'], T['length']>, { length: T['length'] }> {
static override readonly [entityKind]: string = 'SingleStoreVarCharBuilder';
/** @internal */
constructor(name: T['name'], config: SingleStoreVarCharConfig<T['enumValues'], T['length']>) {
super(name, 'string', 'SingleStoreVarChar');
this.config.length = config.length;
this.config.enum = config.enum;
}
/** @internal */
override build<TTableName extends string>(
table: AnySingleStoreTable<{ name: TTableName }>,
): SingleStoreVarChar<MakeColumnConfig<T, TTableName> & { length: T['length']; enumValues: T['enumValues'] }> {
return new SingleStoreVarChar<
MakeColumnConfig<T, TTableName> & { length: T['length']; enumValues: T['enumValues'] }
>(
table,
this.config as ColumnBuilderRuntimeConfig<any, any>,
);
}
}
export class SingleStoreVarChar<
T extends ColumnBaseConfig<'string', 'SingleStoreVarChar'> & { length?: number | undefined },
> extends SingleStoreColumn<T, SingleStoreVarCharConfig<T['enumValues'], T['length']>, { length: T['length'] }> {
static override readonly [entityKind]: string = 'SingleStoreVarChar';
readonly length: T['length'] = this.config.length;
override readonly enumValues = this.config.enum;
getSQLType(): string {
return this.length === undefined ? `varchar` : `varchar(${this.length})`;
}
}
export interface SingleStoreVarCharConfig<
TEnum extends string[] | readonly string[] | undefined = string[] | readonly string[] | undefined,
TLength extends number | undefined = number | undefined,
> {
enum?: TEnum;
length: TLength;
}
export function varchar<U extends string, T extends Readonly<[U, ...U[]]>, L extends number | undefined>(
config: SingleStoreVarCharConfig<T | Writable<T>, L>,
): SingleStoreVarCharBuilderInitial<'', Writable<T>, L>;
export function varchar<
TName extends string,
U extends string,
T extends Readonly<[U, ...U[]]>,
L extends number | undefined,
>(
name: TName,
config: SingleStoreVarCharConfig<T | Writable<T>, L>,
): SingleStoreVarCharBuilderInitial<TName, Writable<T>, L>;
export function varchar(a?: string | SingleStoreVarCharConfig, b?: SingleStoreVarCharConfig): any {
const { name, config } = getColumnNameAndConfig<SingleStoreVarCharConfig>(a, b);
return new SingleStoreVarCharBuilder(name, config as any);
}
Domain
Subdomains
Functions
Dependencies
- column-builder.ts
- column.ts
- common.ts
- entity.ts
- table.ts
- utils.ts
Imported By
Source
Frequently Asked Questions
What does varchar.ts do?
varchar.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, RelationalQuery subdomain.
What functions are defined in varchar.ts?
varchar.ts defines 1 function(s): varchar.
What does varchar.ts depend on?
varchar.ts imports 6 module(s): column-builder.ts, column.ts, common.ts, entity.ts, table.ts, utils.ts.
What files import varchar.ts?
varchar.ts is imported by 1 file(s): all.ts.
Where is varchar.ts in the architecture?
varchar.ts is located at drizzle-orm/src/singlestore-core/columns/varchar.ts (domain: DrizzleORM, subdomain: RelationalQuery, 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