bigint.ts — drizzle-orm Source File
Architecture documentation for bigint.ts, a typescript file in the drizzle-orm codebase. 6 imports, 1 dependents.
Entity Profile
Dependency Diagram
graph LR b668ec7c_3eec_efd8_a611_2f2f76754bfd["bigint.ts"] 83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb["common.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> 83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb 2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426 05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> 05f0a280_d0c9_693a_a4bf_83cc671012d2 27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> 27705a9d_afe9_57dd_8c97_e52d8a67d426 70e1783e_f575_ccd4_36bd_5f0978c2172c["table.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> 70e1783e_f575_ccd4_36bd_5f0978c2172c ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"] b668ec7c_3eec_efd8_a611_2f2f76754bfd --> ecce3253_1e75_a87f_27b3_ca87e81a3024 6dd15b44_b15c_62ef_81b2_e72b28299be9["all.ts"] 6dd15b44_b15c_62ef_81b2_e72b28299be9 --> b668ec7c_3eec_efd8_a611_2f2f76754bfd style b668ec7c_3eec_efd8_a611_2f2f76754bfd 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 { getColumnNameAndConfig } from '~/utils.ts';
import { MySqlColumnBuilderWithAutoIncrement, MySqlColumnWithAutoIncrement } from './common.ts';
export type MySqlBigInt53BuilderInitial<TName extends string> = MySqlBigInt53Builder<{
name: TName;
dataType: 'number';
columnType: 'MySqlBigInt53';
data: number;
driverParam: number | string;
enumValues: undefined;
}>;
export class MySqlBigInt53Builder<T extends ColumnBuilderBaseConfig<'number', 'MySqlBigInt53'>>
extends MySqlColumnBuilderWithAutoIncrement<T, { unsigned: boolean }>
{
static override readonly [entityKind]: string = 'MySqlBigInt53Builder';
constructor(name: T['name'], unsigned: boolean = false) {
super(name, 'number', 'MySqlBigInt53');
this.config.unsigned = unsigned;
}
/** @internal */
override build<TTableName extends string>(
table: AnyMySqlTable<{ name: TTableName }>,
): MySqlBigInt53<MakeColumnConfig<T, TTableName>> {
return new MySqlBigInt53<MakeColumnConfig<T, TTableName>>(
table,
this.config as ColumnBuilderRuntimeConfig<any, any>,
);
}
}
export class MySqlBigInt53<T extends ColumnBaseConfig<'number', 'MySqlBigInt53'>>
extends MySqlColumnWithAutoIncrement<T, { unsigned: boolean }>
{
static override readonly [entityKind]: string = 'MySqlBigInt53';
getSQLType(): string {
return `bigint${this.config.unsigned ? ' unsigned' : ''}`;
}
override mapFromDriverValue(value: number | string): number {
if (typeof value === 'number') {
return value;
}
return Number(value);
}
}
export type MySqlBigInt64BuilderInitial<TName extends string> = MySqlBigInt64Builder<{
name: TName;
dataType: 'bigint';
columnType: 'MySqlBigInt64';
data: bigint;
driverParam: string;
enumValues: undefined;
}>;
export class MySqlBigInt64Builder<T extends ColumnBuilderBaseConfig<'bigint', 'MySqlBigInt64'>>
extends MySqlColumnBuilderWithAutoIncrement<T, { unsigned: boolean }>
{
static override readonly [entityKind]: string = 'MySqlBigInt64Builder';
constructor(name: T['name'], unsigned: boolean = false) {
super(name, 'bigint', 'MySqlBigInt64');
this.config.unsigned = unsigned;
}
/** @internal */
override build<TTableName extends string>(
table: AnyMySqlTable<{ name: TTableName }>,
): MySqlBigInt64<MakeColumnConfig<T, TTableName>> {
return new MySqlBigInt64<MakeColumnConfig<T, TTableName>>(
table,
this.config as ColumnBuilderRuntimeConfig<any, any>,
);
}
}
export class MySqlBigInt64<T extends ColumnBaseConfig<'bigint', 'MySqlBigInt64'>>
extends MySqlColumnWithAutoIncrement<T, { unsigned: boolean }>
{
static override readonly [entityKind]: string = 'MySqlBigInt64';
getSQLType(): string {
return `bigint${this.config.unsigned ? ' unsigned' : ''}`;
}
// eslint-disable-next-line unicorn/prefer-native-coercion-functions
override mapFromDriverValue(value: string): bigint {
return BigInt(value);
}
}
export interface MySqlBigIntConfig<T extends 'number' | 'bigint' = 'number' | 'bigint'> {
mode: T;
unsigned?: boolean;
}
export function bigint<TMode extends MySqlBigIntConfig['mode']>(
config: MySqlBigIntConfig<TMode>,
): TMode extends 'number' ? MySqlBigInt53BuilderInitial<''> : MySqlBigInt64BuilderInitial<''>;
export function bigint<TName extends string, TMode extends MySqlBigIntConfig['mode']>(
name: TName,
config: MySqlBigIntConfig<TMode>,
): TMode extends 'number' ? MySqlBigInt53BuilderInitial<TName> : MySqlBigInt64BuilderInitial<TName>;
export function bigint(a?: string | MySqlBigIntConfig, b?: MySqlBigIntConfig) {
const { name, config } = getColumnNameAndConfig<MySqlBigIntConfig>(a, b);
if (config.mode === 'number') {
return new MySqlBigInt53Builder(name, config.unsigned);
}
return new MySqlBigInt64Builder(name, config.unsigned);
}
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 bigint.ts do?
bigint.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 bigint.ts?
bigint.ts defines 1 function(s): bigint.
What does bigint.ts depend on?
bigint.ts imports 6 module(s): column-builder.ts, column.ts, common.ts, entity.ts, table.ts, utils.ts.
What files import bigint.ts?
bigint.ts is imported by 1 file(s): all.ts.
Where is bigint.ts in the architecture?
bigint.ts is located at drizzle-orm/src/mysql-core/columns/bigint.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