drizzle-orm Architecture Docs
Home / Type/ MySqlJoinFn Type — drizzle-orm Architecture

MySqlJoinFn Type — drizzle-orm Architecture

Architecture documentation for the MySqlJoinFn type/interface in select.types.ts from the drizzle-orm codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  5ab5adee_0e8b_76f0_e326_14aea508a54c["MySqlJoinFn"]
  b145d7b0_f119_a29a_6da7_7ad4e74e20fa["select.types.ts"]
  5ab5adee_0e8b_76f0_e326_14aea508a54c -->|defined in| b145d7b0_f119_a29a_6da7_7ad4e74e20fa
  style 5ab5adee_0e8b_76f0_e326_14aea508a54c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

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

export type MySqlJoinFn<
	T extends AnyMySqlSelectQueryBuilder,
	TDynamic extends boolean,
	TJoinType extends MySqlJoinType,
	TIsLateral extends boolean,
> = <
	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>;

Defined In

Source

Frequently Asked Questions

What is the MySqlJoinFn type?
MySqlJoinFn is a type/interface in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/query-builders/select.types.ts.
Where is MySqlJoinFn defined?
MySqlJoinFn is defined in drizzle-orm/src/mysql-core/query-builders/select.types.ts at line 117.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free