Home / Function/ introspectLibSQLToFile() — drizzle-orm Function Reference

introspectLibSQLToFile() — drizzle-orm Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3["introspectLibSQLToFile()"]
  fb6b4a65_030b_ce6b_df0d_2be21adcd2b3["schemaDiffer.ts"]
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3 -->|defined in| fb6b4a65_030b_ce6b_df0d_2be21adcd2b3
  bf733442_f700_0747_b445_7417f19f76ae["applyLibSQLDiffs()"]
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3 -->|calls| bf733442_f700_0747_b445_7417f19f76ae
  fd1b2256_62ed_ec7e_c677_9d8cbf56136b["testTablesResolver()"]
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3 -->|calls| fd1b2256_62ed_ec7e_c677_9d8cbf56136b
  96edd91d_9f30_fc37_cbd3_7c1229315b14["testColumnsResolver()"]
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3 -->|calls| 96edd91d_9f30_fc37_cbd3_7c1229315b14
  ca971472_1126_152f_0fc8_502996a52ea8["testViewsResolverSqlite()"]
  b6612fd2_9181_aeb0_1129_3ff1a369e4e3 -->|calls| ca971472_1126_152f_0fc8_502996a52ea8
  style b6612fd2_9181_aeb0_1129_3ff1a369e4e3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/tests/schemaDiffer.ts lines 2699–2784

export const introspectLibSQLToFile = async (
	client: Client,
	initSchema: SqliteSchema,
	testName: string,
	casing?: CasingType | undefined,
) => {
	// put in db
	const { sqlStatements } = await applyLibSQLDiffs(initSchema);
	for (const st of sqlStatements) {
		client.execute(st);
	}

	// introspect to schema
	const introspectedSchema = await fromSqliteDatabase(
		{
			query: async <T>(sql: string, params: any[] = []) => {
				return (await client.execute({ sql, args: params })).rows as T[];
			},
			run: async (query: string) => {
				client.execute(query);
			},
		},
		undefined,
	);

	const { version: initV, dialect: initD, ...initRest } = introspectedSchema;

	const initSch = {
		version: '6',
		dialect: 'sqlite',
		id: '0',
		prevId: '0',
		...initRest,
	} as const;

	const initSn = squashSqliteScheme(initSch);

	const validatedCur = sqliteSchema.parse(initSch);

	const file = schemaToTypeScriptSQLite(introspectedSchema, 'camel');

	fs.writeFileSync(`tests/introspect/libsql/${testName}.ts`, file.file);

	const response = await prepareFromSqliteImports([
		`tests/introspect/libsql/${testName}.ts`,
	]);

	const afterFileImports = generateSqliteSnapshot(
		response.tables,
		response.views,
		casing,
	);

	const { version: v2, dialect: d2, ...rest2 } = afterFileImports;

	const sch2 = {
		version: '6',
		dialect: 'sqlite',
		id: '0',
		prevId: '0',
		...rest2,
	} as const;

	const sn2AfterIm = squashSqliteScheme(sch2);
	const validatedCurAfterImport = sqliteSchema.parse(sch2);

	const {
		sqlStatements: afterFileSqlStatements,
		statements: afterFileStatements,
	} = await applyLibSQLSnapshotsDiff(
		sn2AfterIm,
		initSn,
		testTablesResolver(new Set()),
		testColumnsResolver(new Set()),
		testViewsResolverSqlite(new Set()),
		validatedCurAfterImport,
		validatedCur,
	);

	fs.rmSync(`tests/introspect/libsql/${testName}.ts`);

Domain

Subdomains

Frequently Asked Questions

What does introspectLibSQLToFile() do?
introspectLibSQLToFile() is a function in the drizzle-orm codebase, defined in drizzle-kit/tests/schemaDiffer.ts.
Where is introspectLibSQLToFile() defined?
introspectLibSQLToFile() is defined in drizzle-kit/tests/schemaDiffer.ts at line 2699.
What does introspectLibSQLToFile() call?
introspectLibSQLToFile() calls 4 function(s): applyLibSQLDiffs, testColumnsResolver, testTablesResolver, testViewsResolverSqlite.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free