withDelete() — drizzle-orm Function Reference

Architecture documentation for the withDelete() function in index.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  2f2d4671_3075_67ea_c297_67acbfc0a4ae["withDelete()"]
  34f01008_7c45_3804_1fad_b8b59cd8a413["MyDurableObject"]
  2f2d4671_3075_67ea_c297_67acbfc0a4ae -->|defined in| 34f01008_7c45_3804_1fad_b8b59cd8a413
  7c7acbfe_6328_c8df_feba_552ee62a84d9["default.fetch()"]
  7c7acbfe_6328_c8df_feba_552ee62a84d9 -->|calls| 2f2d4671_3075_67ea_c297_67acbfc0a4ae
  b19b108f_def7_3a32_99a3_c8be51ce2fbf["beforeEach()"]
  2f2d4671_3075_67ea_c297_67acbfc0a4ae -->|calls| b19b108f_def7_3a32_99a3_c8be51ce2fbf
  style 2f2d4671_3075_67ea_c297_67acbfc0a4ae fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

integration-tests/tests/sqlite/durable-objects/index.ts lines 1662–1698

	async withDelete(): Promise<void> {
		try {
			await this.beforeEach();
			await this.db.insert(orders).values([
				{ region: 'Europe', product: 'A', amount: 10, quantity: 1 },
				{ region: 'Europe', product: 'A', amount: 20, quantity: 2 },
				{ region: 'Europe', product: 'B', amount: 20, quantity: 2 },
				{ region: 'Europe', product: 'B', amount: 30, quantity: 3 },
				{ region: 'US', product: 'A', amount: 30, quantity: 3 },
				{ region: 'US', product: 'A', amount: 40, quantity: 4 },
				{ region: 'US', product: 'B', amount: 40, quantity: 4 },
				{ region: 'US', product: 'B', amount: 50, quantity: 5 },
			]);

			const averageAmount = this.db.$with('average_amount').as(
				this.db
					.select({
						value: sql`avg(${orders.amount})`.as('value'),
					})
					.from(orders),
			);

			const result = this.db
				.with(averageAmount)
				.delete(orders)
				.where(gt(orders.amount, sql`(select * from ${averageAmount})`))
				.returning({
					id: orders.id,
				})
				.all();

			expect(result).deep.equal([{ id: 6 }, { id: 7 }, { id: 8 }]);
		} catch (error: any) {
			console.error(error);
			throw new Error(`withDelete error`);
		}
	}