withInsert() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

integration-tests/tests/sqlite/durable-objects/index.ts lines 1628–1660

	async withInsert(): Promise<void> {
		try {
			await this.beforeEach();
			const users = sqliteTable('users', {
				username: text('username').notNull(),
				admin: integer('admin', { mode: 'boolean' }).notNull(),
			});

			this.db.run(sql`drop table if exists ${users}`);
			this.db.run(sql`create table ${users} (username text not null, admin integer not null default 0)`);

			const userCount = this.db.$with('user_count').as(
				this.db
					.select({
						value: sql`count(*)`.as('value'),
					})
					.from(users),
			);

			const result = await this.db
				.with(userCount)
				.insert(users)
				.values([{ username: 'user1', admin: sql`((select * from ${userCount}) = 0)` }])
				.returning({
					admin: users.admin,
				});

			expect(result).deep.equal([{ admin: true }]);
		} catch (error: any) {
			console.error(error);
			throw new Error(`withInsert error`);
		}
	}