fromDatabase() — drizzle-orm Function Reference

Source Code

drizzle-kit/src/serializer/sqliteSerializer.ts lines 510–953

export const fromDatabase = async (
	db: SQLiteDB,
	tablesFilter: (table: string) => boolean = (table) => true,
	progressCallback?: (
		stage: IntrospectStage,
		count: number,
		status: IntrospectStatus,
	) => void,
): Promise<SQLiteSchemaInternal> => {
	const result: Record<string, Table> = {};
	const resultViews: Record<string, View> = {};

	const columns = await db.query<{
		tableName: string;
		columnName: string;
		columnType: string;
		notNull: number;
		defaultValue: string;
		pk: number;
		seq: number;
		hidden: number;
		sql: string;
		type: 'view' | 'table';
	}>(`SELECT 
		  m.name as "tableName",
		  p.name as "columnName",
		  p.type as "columnType",
		  p."notnull" as "notNull",
		  p.dflt_value as "defaultValue",
		  p.pk as pk,
		  p.hidden as hidden,
		  m.sql,
		  m.type as type
		FROM sqlite_master AS m
		JOIN pragma_table_xinfo(m.name) AS p
		WHERE (m.type = 'table' OR m.type = 'view') 
		  AND ${filterIgnoredTablesByField('m.tbl_name')};`);

	const tablesWithSeq: string[] = [];

	const seq = await db.query<{
		name: string;
	}>(`SELECT
		  *
		FROM sqlite_master
		WHERE sql GLOB '*[ *' || CHAR(9) || CHAR(10) || CHAR(13) || ']AUTOINCREMENT[^'']*'
    	  AND ${filterIgnoredTablesByField('tbl_name')};`);

	for (const s of seq) {
		tablesWithSeq.push(s.name);
	}

	let columnsCount = 0;
	let tablesCount = new Set();
	let indexesCount = 0;
	let foreignKeysCount = 0;
	let checksCount = 0;
	let viewsCount = 0;

	// append primaryKeys by table
	const tableToPk: { [tname: string]: string[] } = {};

	let tableToGeneratedColumnsInfo: Record<
		string,
		Record<string, ColumnInfo>
	> = {};

	for (const column of columns) {
		if (!tablesFilter(column.tableName)) continue;

		// TODO
		if (column.type !== 'view') {
			columnsCount += 1;
		}
		if (progressCallback) {
			progressCallback('columns', columnsCount, 'fetching');
		}
		const tableName = column.tableName;

		tablesCount.add(tableName);
		if (progressCallback) {