sqlToStr() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SnapshotSerializer called by 4

Entity Profile

DrizzleKit→ SnapshotSerializer→ sqlToStr() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  5de2ec9b_64d7_f004_04c1_e08f9695c862["sqlToStr()"]
  12d176aa_882f_ddcb_4bc8_df3fbb9542b1["utils.ts"]
  5de2ec9b_64d7_f004_04c1_e08f9695c862 -->|defined in| 12d176aa_882f_ddcb_4bc8_df3fbb9542b1
  1b08e484_fe62_7d00_e0d5_3ca64286e7c0["generateGelSnapshot()"]
  1b08e484_fe62_7d00_e0d5_3ca64286e7c0 -->|calls| 5de2ec9b_64d7_f004_04c1_e08f9695c862
  d8d7539a_23af_4a3d_91f6_f60bb60e4c38["generateMySqlSnapshot()"]
  d8d7539a_23af_4a3d_91f6_f60bb60e4c38 -->|calls| 5de2ec9b_64d7_f004_04c1_e08f9695c862
  93c32913_b015_e0e1_4247_f842b1e91d5b["generateSingleStoreSnapshot()"]
  93c32913_b015_e0e1_4247_f842b1e91d5b -->|calls| 5de2ec9b_64d7_f004_04c1_e08f9695c862
  547c33e2_896d_de19_046b_9efd4ec9f8b7["generateSqliteSnapshot()"]
  547c33e2_896d_de19_046b_9efd4ec9f8b7 -->|calls| 5de2ec9b_64d7_f004_04c1_e08f9695c862
  style 5de2ec9b_64d7_f004_04c1_e08f9695c862 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/utils.ts lines 17–30

export const sqlToStr = (sql: SQL, casing: CasingType | undefined) => {
	return sql.toQuery({
		escapeName: () => {
			throw new Error("we don't support params for `sql` default values");
		},
		escapeParam: () => {
			throw new Error("we don't support params for `sql` default values");
		},
		escapeString: () => {
			throw new Error("we don't support params for `sql` default values");
		},
		casing: new CasingCache(casing),
	}).sql;
};