table() — drizzle-orm Function Reference

Architecture documentation for the table() function in update.ts from the drizzle-orm codebase.

Function typescript DrizzleORM QueryBuilders

Entity Profile

DrizzleORM→ QueryBuilders→ table() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  3019a07e_4efd_e6c6_4733_72b565046b72["table()"]
  ebf76db1_7804_287b_622a_ab94e9efc196["update.ts"]
  3019a07e_4efd_e6c6_4733_72b565046b72 -->|defined in| ebf76db1_7804_287b_622a_ab94e9efc196
  style 3019a07e_4efd_e6c6_4733_72b565046b72 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/update.ts lines 152–170

> = <
	TJoinedTable extends PgTable | Subquery | PgViewBase | SQL,
>(
	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
		>
		: TJoinedTable,
	on:
		| (
			(
				updateTable: T['_']['table']['_']['columns'],
				from: T['_']['from'] extends PgTable ? T['_']['from']['_']['columns']
					: T['_']['from'] extends Subquery | PgViewBase ? T['_']['from']['_']['selectedFields']
					: never,
			) => SQL | undefined
		)
		| SQL
		| undefined,
) => PgUpdateJoin<T, TDynamic, TJoinType, TJoinedTable>;