createOne() — drizzle-orm Function Reference

Architecture documentation for the createOne() function in relations.ts from the drizzle-orm codebase.

Function typescript DrizzleORM RelationalQuery

Entity Profile

DrizzleORM→ RelationalQuery→ createOne() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  f7d7c0b1_97b9_e379_f3db_1a9a5627ed9e["createOne()"]
  2f47d090_425d_2e56_2395_4c4d912316f0["relations.ts"]
  f7d7c0b1_97b9_e379_f3db_1a9a5627ed9e -->|defined in| 2f47d090_425d_2e56_2395_4c4d912316f0
  style f7d7c0b1_97b9_e379_f3db_1a9a5627ed9e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/relations.ts lines 521–543

export function createOne<TTableName extends string>(sourceTable: Table) {
	return function one<
		TForeignTable extends Table,
		TColumns extends [
			AnyColumn<{ tableName: TTableName }>,
			...AnyColumn<{ tableName: TTableName }>[],
		],
	>(
		table: TForeignTable,
		config?: RelationConfig<TTableName, TForeignTable['_']['name'], TColumns>,
	): One<
		TForeignTable['_']['name'],
		Equal<TColumns[number]['_']['notNull'], true>
	> {
		return new One(
			sourceTable,
			table,
			config,
			(config?.fields.reduce<boolean>((res, f) => res && f.notNull, true)
				?? false) as Equal<TColumns[number]['_']['notNull'], true>,
		);
	};
}