drizzle-orm Architecture Docs
Home / File/ vector.ts — drizzle-orm Source File

vector.ts — drizzle-orm Source File

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

File typescript DrizzleORM RelationalQuery 8 imports 1 dependents 1 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  1430f954_1f2f_a700_cb5c_77c9d8ff025c["vector.ts"]
  835b37b8_5537_93b3_6081_c47371e60b11["common.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 835b37b8_5537_93b3_6081_c47371e60b11
  fdd47417_aebf_95a0_4226_caaee2108d7c["SingleStoreGeneratedColumnConfig"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> fdd47417_aebf_95a0_4226_caaee2108d7c
  2dc784c6_95e9_4e28_ec81_7caf4acbd426["column-builder.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 2dc784c6_95e9_4e28_ec81_7caf4acbd426
  05f0a280_d0c9_693a_a4bf_83cc671012d2["column.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 05f0a280_d0c9_693a_a4bf_83cc671012d2
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  744f5864_8de4_6d1f_dcfc_5ef4ae408c9a["table.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 744f5864_8de4_6d1f_dcfc_5ef4ae408c9a
  944a2bed_8787_5f43_03e5_9a3b696c293c["index.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> 944a2bed_8787_5f43_03e5_9a3b696c293c
  ecce3253_1e75_a87f_27b3_ca87e81a3024["utils.ts"]
  1430f954_1f2f_a700_cb5c_77c9d8ff025c --> ecce3253_1e75_a87f_27b3_ca87e81a3024
  a70c1ec7_29ee_10ca_2b05_4be0c246a540["all.ts"]
  a70c1ec7_29ee_10ca_2b05_4be0c246a540 --> 1430f954_1f2f_a700_cb5c_77c9d8ff025c
  style 1430f954_1f2f_a700_cb5c_77c9d8ff025c 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 { SQL } from '~/sql/index.ts';
import { getColumnNameAndConfig } from '~/utils.ts';
import { SingleStoreColumn, SingleStoreColumnBuilder, SingleStoreGeneratedColumnConfig } from './common.ts';

export type SingleStoreVectorBuilderInitial<TName extends string> = SingleStoreVectorBuilder<{
	name: TName;
	dataType: 'array';
	columnType: 'SingleStoreVector';
	data: Array<number>;
	driverParam: string;
	enumValues: undefined;
}>;

export class SingleStoreVectorBuilder<T extends ColumnBuilderBaseConfig<'array', 'SingleStoreVector'>>
	extends SingleStoreColumnBuilder<T, SingleStoreVectorConfig>
{
	static override readonly [entityKind]: string = 'SingleStoreVectorBuilder';

	constructor(name: T['name'], config: SingleStoreVectorConfig) {
		super(name, 'array', 'SingleStoreVector');
		this.config.dimensions = config.dimensions;
		this.config.elementType = config.elementType;
	}

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

	/** @internal */
	override generatedAlwaysAs(as: SQL<unknown> | (() => SQL) | T['data'], config?: SingleStoreGeneratedColumnConfig) {
		throw new Error('not implemented');
	}
}

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

	dimensions: number = this.config.dimensions;
	elementType: ElementType | undefined = this.config.elementType;

	getSQLType(): string {
		return `vector(${this.dimensions}, ${this.elementType || 'F32'})`;
	}

	override mapToDriverValue(value: Array<number>) {
		return JSON.stringify(value);
	}

	override mapFromDriverValue(value: string): Array<number> {
		return JSON.parse(value);
	}
}

type ElementType = 'I8' | 'I16' | 'I32' | 'I64' | 'F32' | 'F64';

export interface SingleStoreVectorConfig {
	dimensions: number;
	elementType?: ElementType;
}

export function vector(
	config: SingleStoreVectorConfig,
): SingleStoreVectorBuilderInitial<''>;
export function vector<TName extends string>(
	name: TName,
	config: SingleStoreVectorConfig,
): SingleStoreVectorBuilderInitial<TName>;
export function vector(a: string | SingleStoreVectorConfig, b?: SingleStoreVectorConfig) {
	const { name, config } = getColumnNameAndConfig<SingleStoreVectorConfig>(a, b);
	return new SingleStoreVectorBuilder(name, config);
}

Domain

Subdomains

Functions

Classes

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does vector.ts do?
vector.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 vector.ts?
vector.ts defines 1 function(s): vector.
What does vector.ts depend on?
vector.ts imports 8 module(s): SingleStoreGeneratedColumnConfig, column-builder.ts, column.ts, common.ts, entity.ts, index.ts, table.ts, utils.ts.
What files import vector.ts?
vector.ts is imported by 1 file(s): all.ts.
Where is vector.ts in the architecture?
vector.ts is located at drizzle-orm/src/singlestore-core/columns/vector.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