$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
  f8fa7333_b64d_b924_e736_6cbea306068f["$returningId()"]
  d9829954_9fca_878f_0f03_c2600b4170e4["MySqlInsertBase"]
  f8fa7333_b64d_b924_e736_6cbea306068f -->|defined in| d9829954_9fca_878f_0f03_c2600b4170e4
  style f8fa7333_b64d_b924_e736_6cbea306068f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/insert.ts lines 281–294

	$returningId(): MySqlInsertWithout<
		MySqlInsertReturning<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 = returning;
		return this as any;
	}