embeddedMigrations() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow called by 2

Entity Profile

DrizzleKit→ CLIWorkflow→ embeddedMigrations() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8["embeddedMigrations()"]
  b14d3855_8cce_38c9_8952_a9d014c2fb1b["migrate.ts"]
  a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8 -->|defined in| b14d3855_8cce_38c9_8952_a9d014c2fb1b
  9db4762b_73d0_9f4c_0b4a_81e3441cd04e["dropMigration()"]
  9db4762b_73d0_9f4c_0b4a_81e3441cd04e -->|calls| a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8
  cb2d3951_4fcb_d824_359b_9f044d2f7e6c["writeResult()"]
  cb2d3951_4fcb_d824_359b_9f044d2f7e6c -->|calls| a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8
  style a11e5277_29c6_14fc_5eda_d9fa4ed1ddc8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/migrate.ts lines 1460–1483

export const embeddedMigrations = (journal: Journal, driver?: Driver) => {
	let content = driver === 'expo'
		? '// This file is required for Expo/React Native SQLite migrations - https://orm.drizzle.team/quick-sqlite/expo\n\n'
		: '';

	content += "import journal from './meta/_journal.json';\n";
	journal.entries.forEach((entry) => {
		content += `import m${entry.idx.toString().padStart(4, '0')} from './${entry.tag}.sql';\n`;
	});

	content += `
  export default {
    journal,
    migrations: {
      ${
		journal.entries
			.map((it) => `m${it.idx.toString().padStart(4, '0')}`)
			.join(',\n')
	}
    }
  }
  `;
	return content;
};