$withCache() — drizzle-orm Function Reference

Architecture documentation for the $withCache() function in select.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders

Entity Profile

DrizzleORM→ QueryBuilders→ $withCache() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  5ba5dc50_5b14_9ccb_9055_a65fc3074c05["$withCache()"]
  ca52fda7_20e9_67a9_3dbd_c1b59a433dbf["SQLiteSelectBase"]
  5ba5dc50_5b14_9ccb_9055_a65fc3074c05 -->|defined in| ca52fda7_20e9_67a9_3dbd_c1b59a433dbf
  style 5ba5dc50_5b14_9ccb_9055_a65fc3074c05 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sqlite-core/query-builders/select.ts lines 932–939

	$withCache(config?: { config?: CacheConfig; tag?: string; autoInvalidate?: boolean } | false) {
		this.cacheConfig = config === undefined
			? { config: {}, enable: true, autoInvalidate: true }
			: config === false
			? { enable: false }
			: { enable: true, autoInvalidate: true, ...config };
		return this;
	}