tinyint.ts — drizzle-orm Source File

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

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

Entity Profile

DrizzleORM→ SQLDialects→ tinyint.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  e2933329_fbd5_9471_e054_a461e80d4c18["tinyint.ts"]
  83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb["common.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> 83c65ad5_22a0_d33f_47b8_c2ed1c8d8bbb
  d9cbb4b8_099f_202c_f966_e6dfe9688e35["int.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> d9cbb4b8_099f_202c_f966_e6dfe9688e35
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  70e1783e_f575_ccd4_36bd_5f0978c2172c["table.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> 70e1783e_f575_ccd4_36bd_5f0978c2172c
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  e2933329_fbd5_9471_e054_a461e80d4c18 --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  6dd15b44_b15c_62ef_81b2_e72b28299be9["all.ts"]
  6dd15b44_b15c_62ef_81b2_e72b28299be9 --> e2933329_fbd5_9471_e054_a461e80d4c18
  style e2933329_fbd5_9471_e054_a461e80d4c18 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';
import type { MySqlIntConfig } from './int.ts';

export type MySqlTinyIntBuilderInitial<TName extends string> = MySqlTinyIntBuilder<{
	name: TName;
	dataType: 'number';
	columnType: 'MySqlTinyInt';
	data: number;
	driverParam: number | string;
	enumValues: undefined;
}>;

export class MySqlTinyIntBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlTinyInt'>>
	extends MySqlColumnBuilderWithAutoIncrement<T, MySqlIntConfig>
{
	static override readonly [entityKind]: string = 'MySqlTinyIntBuilder';

	constructor(name: T['name'], config?: MySqlIntConfig) {
		super(name, 'number', 'MySqlTinyInt');
		this.config.unsigned = config ? config.unsigned : false;
	}

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

export class MySqlTinyInt<T extends ColumnBaseConfig<'number', 'MySqlTinyInt'>>
	extends MySqlColumnWithAutoIncrement<T, MySqlIntConfig>
{
	static override readonly [entityKind]: string = 'MySqlTinyInt';

	getSQLType(): string {
		return `tinyint${this.config.unsigned ? ' unsigned' : ''}`;
	}

	override mapFromDriverValue(value: number | string): number {
		if (typeof value === 'string') {
			return Number(value);
		}
		return value;
	}
}

export function tinyint(): MySqlTinyIntBuilderInitial<''>;
export function tinyint(
	config?: MySqlIntConfig,
): MySqlTinyIntBuilderInitial<''>;
export function tinyint<TName extends string>(
	name: TName,
	config?: MySqlIntConfig,
): MySqlTinyIntBuilderInitial<TName>;
export function tinyint(a?: string | MySqlIntConfig, b?: MySqlIntConfig) {
	const { name, config } = getColumnNameAndConfig<MySqlIntConfig>(a, b);
	return new MySqlTinyIntBuilder(name, config);
}

Domain

DrizzleORM

Subdomains

SQLDialects

Functions

tinyint()

Classes

Types

MySqlTinyIntBuilderInitial

Dependencies

column-builder.ts
column.ts
common.ts
entity.ts
int.ts
table.ts
utils.ts

Imported By

drizzle-orm/src/mysql-core/columns/all.ts

Source

View on GitHub

Frequently Asked Questions

What does tinyint.ts do?

tinyint.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 tinyint.ts?

tinyint.ts defines 1 function(s): tinyint.

What does tinyint.ts depend on?

tinyint.ts imports 7 module(s): column-builder.ts, column.ts, common.ts, entity.ts, int.ts, table.ts, utils.ts.

What files import tinyint.ts?

tinyint.ts is imported by 1 file(s): all.ts.

Where is tinyint.ts in the architecture?

tinyint.ts is located at drizzle-orm/src/mysql-core/columns/tinyint.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