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
  80b30668_dbf2_d9a5_8314_4e1fca740b28["table()"]
  b145d7b0_f119_a29a_6da7_7ad4e74e20fa["select.types.ts"]
  80b30668_dbf2_d9a5_8314_4e1fca740b28 -->|defined in| b145d7b0_f119_a29a_6da7_7ad4e74e20fa
  style 80b30668_dbf2_d9a5_8314_4e1fca740b28 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/select.types.ts lines 122–132

> = <
	TJoinedTable extends (TIsLateral extends true ? Subquery | SQL : MySqlTable | Subquery | MySqlViewBase | SQL),
	TJoinedName extends GetSelectTableName<TJoinedTable> = GetSelectTableName<TJoinedTable>,
>(
	table: TJoinedTable,
	on: ((aliases: T['_']['selection']) => SQL | undefined) | SQL | undefined,
	onIndex?:
		| (TJoinedTable extends MySqlTable ? IndexConfig
			: 'Index hint configuration is allowed only for MySqlTable and not for subqueries or views')
		| undefined,
) => MySqlJoin<T, TDynamic, TJoinType, TJoinedTable, TJoinedName>;