pgSuggestions() — drizzle-orm Function Reference

Source Code

drizzle-kit/src/cli/commands/pgPushUtils.ts lines 59–269

export const pgSuggestions = async (db: DB, statements: JsonStatement[]) => {
	let shouldAskForApprove = false;
	const statementsToExecute: string[] = [];
	const infoToPrint: string[] = [];

	const tablesToRemove: string[] = [];
	const columnsToRemove: string[] = [];
	const schemasToRemove: string[] = [];
	const tablesToTruncate: string[] = [];
	const matViewsToRemove: string[] = [];

	let renamedSchemas: Record<string, string> = {};
	let renamedTables: Record<string, string> = {};

	for (const statement of statements) {
		if (statement.type === 'rename_schema') {
			renamedSchemas[statement.to] = statement.from;
		} else if (statement.type === 'rename_table') {
			renamedTables[concatSchemaAndTableName(statement.toSchema, statement.tableNameTo)] = statement.tableNameFrom;
		} else if (statement.type === 'drop_table') {
			const res = await db.query(
				`select count(*) as count from ${
					tableNameWithSchemaFrom(statement.schema, statement.tableName, renamedSchemas, renamedTables)
				}`,
			);
			const count = Number(res[0].count);
			if (count > 0) {
				infoToPrint.push(`· You're about to delete ${chalk.underline(statement.tableName)} table with ${count} items`);
				// statementsToExecute.push(
				//   `truncate table ${tableNameWithSchemaFrom(statement)} cascade;`
				// );
				tablesToRemove.push(statement.tableName);
				shouldAskForApprove = true;
			}
		} else if (statement.type === 'drop_view' && statement.materialized) {
			const res = await db.query(`select count(*) as count from "${statement.schema ?? 'public'}"."${statement.name}"`);
			const count = Number(res[0].count);
			if (count > 0) {
				infoToPrint.push(
					`· You're about to delete "${chalk.underline(statement.name)}" materialized view with ${count} items`,
				);

				matViewsToRemove.push(statement.name);
				shouldAskForApprove = true;
			}
		} else if (statement.type === 'alter_table_drop_column') {
			const res = await db.query(
				`select count(*) as count from ${
					tableNameWithSchemaFrom(statement.schema, statement.tableName, renamedSchemas, renamedTables)
				}`,
			);
			const count = Number(res[0].count);
			if (count > 0) {
				infoToPrint.push(
					`· You're about to delete ${
						chalk.underline(statement.columnName)
					} column in ${statement.tableName} table with ${count} items`,
				);
				columnsToRemove.push(`${statement.tableName}_${statement.columnName}`);
				shouldAskForApprove = true;
			}
		} else if (statement.type === 'drop_schema') {
			const res = await db.query(
				`select count(*) as count from information_schema.tables where table_schema = '${statement.name}';`,
			);
			const count = Number(res[0].count);
			if (count > 0) {
				infoToPrint.push(`· You're about to delete ${chalk.underline(statement.name)} schema with ${count} tables`);
				schemasToRemove.push(statement.name);
				shouldAskForApprove = true;
			}
		} else if (statement.type === 'alter_table_alter_column_set_type') {
			const res = await db.query(
				`select count(*) as count from ${
					tableNameWithSchemaFrom(statement.schema, statement.tableName, renamedSchemas, renamedTables)
				}`,
			);
			const count = Number(res[0].count);
			if (count > 0) {
				infoToPrint.push(
					`· You're about to change ${chalk.underline(statement.columnName)} column type from ${