updateWithReturningFields() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

integration-tests/tests/sqlite/durable-objects/index.ts lines 725–741

	async updateWithReturningFields(): Promise<void> {
		try {
			await this.beforeEach();
			const now = Date.now();

			this.db.insert(usersTable).values({ name: 'John' }).run();
			const users = this.db.update(usersTable).set({ name: 'Jane' }).where(eq(usersTable.name, 'John')).returning()
				.all();

			expect(users[0]!.createdAt).instanceOf(Date);
			expect(Math.abs(users[0]!.createdAt.getTime() - now)).lessThan(5000);
			expect(users).deep.equal([{ id: 1, name: 'Jane', verified: false, json: null, createdAt: users[0]!.createdAt }]);
		} catch (error: any) {
			console.error(error);
			throw new Error('updateWithReturningFields has broken');
		}
	}