createInsertSchema() — drizzle-orm Function Reference

Architecture documentation for the createInsertSchema() function in schema.ts from the drizzle-orm codebase.

Function typescript ValidationAdapters SchemaRefinement calls 2

Entity Profile

ValidationAdapters→ SchemaRefinement→ createInsertSchema() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  5e15e483_73fa_7a28_a2c2_91e5a4f78efd["createInsertSchema()"]
  b3de3d3d_2c66_6c17_9e29_4ae6af2ae68f["schema.ts"]
  5e15e483_73fa_7a28_a2c2_91e5a4f78efd -->|defined in| b3de3d3d_2c66_6c17_9e29_4ae6af2ae68f
  cb025dc0_bc0b_8055_d943_c2035efad279["getColumns()"]
  5e15e483_73fa_7a28_a2c2_91e5a4f78efd -->|calls| cb025dc0_bc0b_8055_d943_c2035efad279
  ca765c74_0736_6b3c_ef77_d23f23e865ce["handleColumns()"]
  5e15e483_73fa_7a28_a2c2_91e5a4f78efd -->|calls| ca765c74_0736_6b3c_ef77_d23f23e865ce
  style 5e15e483_73fa_7a28_a2c2_91e5a4f78efd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-arktype/src/schema.ts lines 76–86

export const createInsertSchema = ((
	entity: Table,
	refine?: Record<string, any>,
) => {
	const columns = getColumns(entity);
	return handleColumns(columns, refine ?? {}, {
		never: (column) => column?.generated?.type === 'always' || column?.generatedIdentity?.type === 'always',
		optional: (column) => !column.notNull || (column.notNull && column.hasDefault),
		nullable: (column) => !column.notNull,
	}) as any;
}) as CreateInsertSchema;