table() — drizzle-orm Function Reference

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

Function typescript DrizzleORM QueryBuilders

Entity Profile

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

Dependency Diagram

graph TD
  25e9e565_6341_e663_55b9_c16c314bca81["table()"]
  65d45edf_0d8a_b7f0_1780_573c12d9a0e6["select.types.ts"]
  25e9e565_6341_e663_55b9_c16c314bca81 -->|defined in| 65d45edf_0d8a_b7f0_1780_573c12d9a0e6
  style 25e9e565_6341_e663_55b9_c16c314bca81 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/query-builders/select.types.ts lines 120–129

> = <
	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : PgTable | Subquery | PgViewBase | SQL),
	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
>(
	table: TableLikeHasEmptySelection<TJoinedTable> extends true ? DrizzleTypeError<
			"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause"
		>
		: TJoinedTable,
	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
) => PgSelectJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;