$returningId() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

graph TD
  f0f4a455_c455_c51e_6622_b8e005325298["$returningId()"]
  789024c2_65e9_4316_d78e_e80becf0d8aa["SingleStoreInsertBase"]
  f0f4a455_c455_c51e_6622_b8e005325298 -->|defined in| 789024c2_65e9_4316_d78e_e80becf0d8aa
  style f0f4a455_c455_c51e_6622_b8e005325298 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/singlestore-core/query-builders/insert.ts lines 254–267

	$returningId(): SingleStoreInsertWithout<
		SingleStoreInsertReturning<this, TDynamic>,
		TDynamic,
		'$returningId'
	> {
		const returning: SelectedFieldsOrdered = [];
		for (const [key, value] of Object.entries(this.config.table[Table.Symbol.Columns])) {
			if (value.primary) {
				returning.push({ field: value, path: [key] });
			}
		}
		this.config.returning = orderSelectedFields<SingleStoreColumn>(this.config.table[Table.Symbol.Columns]);
		return this as any;
	}