binary() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects called by 1

Entity Profile

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

Dependency Diagram

graph TD
  cc8f5089_4e9a_b525_7bfa_9a7f92757abd["binary()"]
  ae99d625_4bae_76fd_4d10_fa20ca723d3b["binary.ts"]
  cc8f5089_4e9a_b525_7bfa_9a7f92757abd -->|defined in| ae99d625_4bae_76fd_4d10_fa20ca723d3b
  bcad2196_4270_2069_38f6_f41570da5b12["getSQLType()"]
  bcad2196_4270_2069_38f6_f41570da5b12 -->|calls| cc8f5089_4e9a_b525_7bfa_9a7f92757abd
  style cc8f5089_4e9a_b525_7bfa_9a7f92757abd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/columns/binary.ts lines 73–76

export function binary(a?: string | MySqlBinaryConfig, b: MySqlBinaryConfig = {}) {
	const { name, config } = getColumnNameAndConfig<MySqlBinaryConfig>(a, b);
	return new MySqlBinaryBuilder(name, config.length);
}