relationsToTypeScript() — drizzle-orm Function Reference

Source Code

drizzle-kit/src/cli/commands/introspect.ts lines 750–900

export const relationsToTypeScript = (
	schema: {
		tables: Record<
			string,
			{
				schema?: string;
				foreignKeys: Record<
					string,
					{
						name: string;
						tableFrom: string;
						columnsFrom: string[];
						tableTo: string;
						schemaTo?: string;
						columnsTo: string[];
						onUpdate?: string | undefined;
						onDelete?: string | undefined;
					}
				>;
			}
		>;
	},
	casing: Casing,
) => {
	const imports: string[] = [];
	const tableRelations: Record<
		string,
		{
			name: string;
			type: 'one' | 'many';
			tableFrom: string;
			schemaFrom?: string;
			columnFrom: string;
			tableTo: string;
			schemaTo?: string;
			columnTo: string;
			relationName?: string;
		}[]
	> = {};

	Object.values(schema.tables).forEach((table) => {
		Object.values(table.foreignKeys).forEach((fk) => {
			const tableNameFrom = paramNameFor(fk.tableFrom, table.schema);
			const tableNameTo = paramNameFor(fk.tableTo, fk.schemaTo);
			const tableFrom = withCasing(tableNameFrom.replace(/:+/g, ''), casing);
			const tableTo = withCasing(tableNameTo.replace(/:+/g, ''), casing);
			const columnFrom = withCasing(fk.columnsFrom[0], casing);
			const columnTo = withCasing(fk.columnsTo[0], casing);

			imports.push(tableTo, tableFrom);

			// const keyFrom = `${schemaFrom}.${tableFrom}`;
			const keyFrom = tableFrom;

			if (!tableRelations[keyFrom]) {
				tableRelations[keyFrom] = [];
			}

			tableRelations[keyFrom].push({
				name: singular(tableTo),
				type: 'one',
				tableFrom,
				columnFrom,
				tableTo,
				columnTo,
			});

			// const keyTo = `${schemaTo}.${tableTo}`;
			const keyTo = tableTo;

			if (!tableRelations[keyTo]) {
				tableRelations[keyTo] = [];
			}

			tableRelations[keyTo].push({
				name: plural(tableFrom),
				type: 'many',
				tableFrom: tableTo,
				columnFrom: columnTo,
				tableTo: tableFrom,
				columnTo: columnFrom,