withCheckOption() — drizzle-orm Function Reference

Architecture documentation for the withCheckOption() function in view.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects

Entity Profile

DrizzleORM→ SQLDialects→ withCheckOption() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  471c942d_1230_b5ec_52d1_a2937e53859c["withCheckOption()"]
  6b3708db_738c_3b26_2eda_7803c654a946["ViewBuilderCore"]
  471c942d_1230_b5ec_52d1_a2937e53859c -->|defined in| 6b3708db_738c_3b26_2eda_7803c654a946
  style 471c942d_1230_b5ec_52d1_a2937e53859c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/view.ts lines 49–54

	withCheckOption(
		withCheckOption?: Exclude<ViewBuilderConfig['withCheckOption'], undefined>,
	): this {
		this.config.withCheckOption = withCheckOption ?? 'cascaded';
		return this;
	}