drizzle-orm Architecture Docs
Home / Class/ PrimaryKeyBuilder Class — drizzle-orm Architecture

PrimaryKeyBuilder Class — drizzle-orm Architecture

Architecture documentation for the PrimaryKeyBuilder class in primary-keys.ts from the drizzle-orm codebase.

Class typescript DrizzleORM

Entity Profile

Dependency Diagram

graph TD
  b78ef011_08f4_dea0_12fd_b8965170d74c["PrimaryKeyBuilder"]
  a7ff59de_fcfb_68fe_6665_16d01fc2937f["primary-keys.ts"]
  b78ef011_08f4_dea0_12fd_b8965170d74c -->|defined in| a7ff59de_fcfb_68fe_6665_16d01fc2937f
  bcd61256_106c_ed4e_c350_cec550019bbc["constructor()"]
  b78ef011_08f4_dea0_12fd_b8965170d74c -->|method| bcd61256_106c_ed4e_c350_cec550019bbc
  dfd450e0_d701_fd7d_c07c_279ebb6b744b["build()"]
  b78ef011_08f4_dea0_12fd_b8965170d74c -->|method| dfd450e0_d701_fd7d_c07c_279ebb6b744b

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/primary-keys.ts lines 24–49

export class PrimaryKeyBuilder {
	static readonly [entityKind]: string = 'SQLitePrimaryKeyBuilder';

	declare _: {
		brand: 'SQLitePrimaryKeyBuilder';
	};

	/** @internal */
	columns: SQLiteColumn[];

	/** @internal */
	name?: string;

	constructor(
		columns: SQLiteColumn[],
		name?: string,
	) {
		this.columns = columns;
		this.name = name;
	}

	/** @internal */
	build(table: SQLiteTable): PrimaryKey {
		return new PrimaryKey(table, this.columns, this.name);
	}
}

Domain

Defined In

Source

Frequently Asked Questions

What is the PrimaryKeyBuilder class?
PrimaryKeyBuilder is a class in the drizzle-orm codebase, defined in drizzle-orm/src/sqlite-core/primary-keys.ts.
Where is PrimaryKeyBuilder defined?
PrimaryKeyBuilder is defined in drizzle-orm/src/sqlite-core/primary-keys.ts at line 24.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free