Merge pull request #3270 from sqlslinger/AddFixOrphanUsersOption

sp_DatabaseRestore: Add @FixOrphanUsers option

Author: BrentOzar

sp_DatabaseRestore.sql

@@ -30,6 +30,7 @@ ALTER PROCEDURE [dbo].[sp_DatabaseRestore]
     @SkipBackupsAlreadyInMsdb BIT = 0,
     @DatabaseOwner sysname = NULL,
     @SetTrustworthyON BIT = 0,
+    @FixOrphanUsers BIT = 0,
     @Execute CHAR(1) = Y,
     @FileExtensionDiff NVARCHAR(128) = NULL,
     @Debug INT = 0, 
@@ -1588,7 +1589,45 @@ IF @DatabaseOwner IS NOT NULL
 			END
 		END;
 
- -- If test restore then blow the database away (be careful)
+-- Link a user entry in the sys.database_principals system catalog view in the restored database to a SQL Server login of the same name
+IF @FixOrphanUsers = 1 
+	BEGIN
+		SET @sql = N'
+-- Fixup Orphan Users by setting database user sid to match login sid
+DECLARE @FixOrphansSql NVARCHAR(MAX);
+DECLARE @OrphanUsers TABLE (SqlToExecute NVARCHAR(MAX));
+USE ' + @RestoreDatabaseName + ';
+
+INSERT @OrphanUsers
+SELECT ''ALTER USER ['' + d.name + ''] WITH LOGIN = ['' + d.name + '']; ''
+	FROM  sys.database_principals d
+	INNER JOIN master.sys.server_principals s ON d.name COLLATE DATABASE_DEFAULT = s.name COLLATE DATABASE_DEFAULT
+	WHERE d.type_desc = ''SQL_USER''
+		AND d.name NOT IN (''guest'',''dbo'')
+		AND d.sid <> s.sid
+	ORDER BY d.name;
+
+SELECT @FixOrphansSql = (SELECT SqlToExecute AS [text()] FROM @OrphanUsers FOR XML PATH (''''), TYPE).value(''text()[1]'',''NVARCHAR(MAX)'');
+
+IF @FixOrphansSql IS NULL 
+	PRINT ''No orphan users require a sid fixup.'';
+ELSE
+BEGIN
+	PRINT ''Fix Orphan Users: '' + @FixOrphansSql;
+	EXECUTE(@FixOrphansSql);
+END;'
+
+		IF @Debug = 1 OR @Execute = 'N'
+		BEGIN
+			IF @sql IS NULL PRINT '@sql is NULL for Fix Orphan Users';
+			PRINT @sql;
+		END;
+
+		IF @Debug IN (0, 1) AND @Execute = 'Y'
+			EXECUTE [dbo].[CommandExecute] @DatabaseContext = 'master', @Command = @sql, @CommandType = 'UPDATE', @Mode = 1, @DatabaseName = @UnquotedRestoreDatabaseName, @LogToTable = 'Y', @Execute = 'Y';
+	END; 
+
+-- If test restore then blow the database away (be careful)
 IF @TestRestore = 1
 	BEGIN
 		SET @sql = N'DROP DATABASE ' + @RestoreDatabaseName + NCHAR(13);