join() — drizzle-orm Function Reference

Architecture documentation for the join() function in sql.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects called by 4

Entity Profile

DrizzleORM→ SQLDialects→ join() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb["join()"]
  99347ab2_b1a1_faf4_e37c_7643e4b2eb8a["sql.ts"]
  d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb -->|defined in| 99347ab2_b1a1_faf4_e37c_7643e4b2eb8a
  fd2db1bb_b6da_94bf_ea4b_4502ee7a2b9d["mapColumnsInSQLToAlias()"]
  fd2db1bb_b6da_94bf_ea4b_4502ee7a2b9d -->|calls| d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb
  a70813f1_21d0_091a_8841_404ffe20513b["and()"]
  a70813f1_21d0_091a_8841_404ffe20513b -->|calls| d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb
  78d1cc66_0fa2_7769_d4c0_0c702150d301["or()"]
  78d1cc66_0fa2_7769_d4c0_0c702150d301 -->|calls| d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb
  f5a982b1_e6b9_5bf8_12b4_3d305d59c2ae["buildQueryFromSourceParams()"]
  f5a982b1_e6b9_5bf8_12b4_3d305d59c2ae -->|calls| d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb
  style d6f243fd_6cbd_d4f3_d0bc_78f4860f53cb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sql/sql.ts lines 528–537

	export function join(chunks: SQLChunk[], separator?: SQLChunk): SQL {
		const result: SQLChunk[] = [];
		for (const [i, chunk] of chunks.entries()) {
			if (i > 0 && separator !== undefined) {
				result.push(separator);
			}
			result.push(chunk);
		}
		return new SQL(result);
	}