introspectGelToFile() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery

Entity Profile

DrizzleORM→ RelationalQuery→ introspectGelToFile() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  f4931410_9115_52c4_55a3_34d8d87fa114["introspectGelToFile()"]
  fb6b4a65_030b_ce6b_df0d_2be21adcd2b3["schemaDiffer.ts"]
  f4931410_9115_52c4_55a3_34d8d87fa114 -->|defined in| fb6b4a65_030b_ce6b_df0d_2be21adcd2b3
  style f4931410_9115_52c4_55a3_34d8d87fa114 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/tests/schemaDiffer.ts lines 2405–2432

export const introspectGelToFile = async (
	client: GelClient,
	testName: string,
	schemas: string[] = ['public'],
	entities?: Entities,
	casing?: CasingType | undefined,
) => {
	// introspect to schema
	const introspectedSchema = await fromGelDatabase(
		{
			query: async (query: string, values?: any[] | undefined) => {
				const res = await client.querySQL(query, values);
				return res as any[];
			},
		},
		undefined,
		schemas,
		entities,
	);

	// write to ts file
	const file = schemaToTypeScriptGel(introspectedSchema, 'camel');

	const path = `tests/introspect/gel/${testName}.ts`;
	fs.writeFileSync(path, file.file);

	return path;
};