returingSql() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1 called by 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

integration-tests/tests/sqlite/durable-objects/index.ts lines 490–507

	async returingSql(): Promise<void> {
		try {
			await this.beforeEach();

			const users = this.db
				.insert(usersTable)
				.values({ name: 'John' })
				.returning({
					name: sql`upper(${usersTable.name})`,
				})
				.all();

			expect(users).deep.equal([{ name: 'JOHN' }]);
		} catch (error: any) {
			console.error(error);
			throw new Error('returingSql has broken');
		}
	}