Home / File/ binary.ts — drizzle-orm Source File

binary.ts — drizzle-orm Source File

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

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

Entity Profile

Dependency Diagram

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

export type SingleStoreBinaryBuilderInitial<TName extends string> = SingleStoreBinaryBuilder<{
	name: TName;
	dataType: 'string';
	columnType: 'SingleStoreBinary';
	data: string;
	driverParam: string;
	enumValues: undefined;
	generated: undefined;
}>;

export class SingleStoreBinaryBuilder<T extends ColumnBuilderBaseConfig<'string', 'SingleStoreBinary'>>
	extends SingleStoreColumnBuilder<
		T,
		SingleStoreBinaryConfig
	>
{
	static override readonly [entityKind]: string = 'SingleStoreBinaryBuilder';

	constructor(name: T['name'], length: number | undefined) {
		super(name, 'string', 'SingleStoreBinary');
		this.config.length = length;
	}

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

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

	length: number | undefined = this.config.length;

	override mapFromDriverValue(value: string | Buffer | Uint8Array): string {
		if (typeof value === 'string') return value;
		if (Buffer.isBuffer(value)) return value.toString();

		const str: string[] = [];
		for (const v of value) {
			str.push(v === 49 ? '1' : '0');
		}

		return str.join('');
	}

	getSQLType(): string {
		return this.length === undefined ? `binary` : `binary(${this.length})`;
	}
}

export interface SingleStoreBinaryConfig {
	length?: number;
}

export function binary(): SingleStoreBinaryBuilderInitial<''>;
export function binary(
	config?: SingleStoreBinaryConfig,
): SingleStoreBinaryBuilderInitial<''>;
export function binary<TName extends string>(
	name: TName,
	config?: SingleStoreBinaryConfig,
): SingleStoreBinaryBuilderInitial<TName>;
export function binary(a?: string | SingleStoreBinaryConfig, b: SingleStoreBinaryConfig = {}) {
	const { name, config } = getColumnNameAndConfig<SingleStoreBinaryConfig>(a, b);
	return new SingleStoreBinaryBuilder(name, config.length);
}

Domain

Subdomains

Functions

Dependencies

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

Frequently Asked Questions

What does binary.ts do?
binary.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, QueryBuilders subdomain.
What functions are defined in binary.ts?
binary.ts defines 1 function(s): binary.
What does binary.ts depend on?
binary.ts imports 6 module(s): column-builder.ts, column.ts, common.ts, entity.ts, table.ts, utils.ts.
What files import binary.ts?
binary.ts is imported by 1 file(s): all.ts.
Where is binary.ts in the architecture?
binary.ts is located at drizzle-orm/src/singlestore-core/columns/binary.ts (domain: DrizzleORM, subdomain: QueryBuilders, 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