functions/Find-DbaOrphanedFile.ps1
|
Function Find-DbaOrphanedFile { <# .SYNOPSIS Find-DbaOrphanedFile finds orphaned database files. Orphaned database files are files not associated with any attached database. .DESCRIPTION This command searches all directories associated with SQL database files for database files that are not currently in use by the SQL Server instance. By default, it looks for orphaned .mdf, .ldf and .ndf files in the root\data directory, the default data path, the default log path, the system paths and any directory in use by any attached directory. You can specify additional filetypes using the -FileType parameter, and additional paths to search using the -Path parameter. .PARAMETER SqlServer The SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2000 or higher. .PARAMETER SqlCredential Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. .PARAMETER Path Used to specify extra directories to search in addition to the default data and log directories. .PARAMETER FileType Used to specify other filetypes in addition to mdf, ldf, ndf. No dot required, just pass the extension. .PARAMETER LocalOnly Shows only the local filenames .PARAMETER RemoteOnly Shows only the remote filenames .NOTES Author: Sander Stad (@sqlstad), sqlstad.nl Requires: sysadmin access on SQL Servers dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com) Copyright (C) 2016 Chrissy LeMaire This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. .LINK https://dbatools.io/Find-DbaOrphanedFile .EXAMPLE Find-DbaOrphanedFile -SqlServer sqlserver2014a Logs into the SQL Server "sqlserver2014a" using Windows credentials and searches for orphaned files. Returns server name, local filename, and unc path to file. .EXAMPLE Find-DbaOrphanedFile -SqlServer sqlserver2014a -SqlCredential $cred Logs into the SQL Server "sqlserver2014a" using alternative credentials and searches for orphaned files. Returns server name, local filename, and unc path to file. .EXAMPLE Find-DbaOrphanedFile -SqlServer sql2014 -Path 'E:\Dir1', 'E:\Dir2' Finds the orphaned files in "E:\Dir1" and "E:Dir2" in addition to the default directories. .EXAMPLE Find-DbaOrphanedFile -SqlServer sql2014 -LocalOnly Returns only the local filepath. Using LocalOnly with multiple servers is not recommended since it does not return the associated server name. .EXAMPLE Find-DbaOrphanedFile -SqlServer sql2014 -RemoteOnly Returns only the remote filepath. Using LocalOnly with multiple servers is not recommended since it does not return the associated server name. .EXAMPLE Find-DbaOrphanedFile -SqlServer sql2014, sql2016 -FileType fsf, mld Finds the orphaned ending with ".fsf" and ".mld" in addition to the default filetypes ".mdf", ".ldf", ".ndf" for both the servers sql2014 and sql2016. #> [CmdletBinding()] Param ( [parameter(Mandatory = $true, ValueFromPipeline = $true)] [Alias("ServerInstance", "SqlInstance")] [object]$SqlServer, [parameter(Mandatory = $false)] [object]$SqlCredential, [parameter(Mandatory = $false)] [string[]]$Path, [string[]]$FileType, [switch]$LocalOnly, [switch]$RemoteOnly ) BEGIN { function Get-SqlFileStructure { param ( [Parameter(Mandatory = $true, Position = 1)] [Microsoft.SqlServer.Management.Smo.SqlSmoObject]$smoserver ) if ($smoserver.versionMajor -eq 8) { $sql = "select filename from sysaltfiles" } else { $sql = "SELECT Physical_Name AS filename FROM sys.master_files mf INNER JOIN sys.databases db ON db.database_id = mf.database_id" } $dbfiletable = $smoserver.ConnectionContext.ExecuteWithResults($sql) $ftfiletable = $dbfiletable.Tables[0].Clone() $dbfiletable.Tables[0].TableName = "data" foreach ($db in $databaselist) { # Add support for Full Text Catalogs in Sql Server 2005 and below if ($server.VersionMajor -lt 10) { #$dbname = $db.name $fttable = $null = $smoserver.Databases[$database].ExecuteWithResults('sp_help_fulltext_catalogs') foreach ($ftc in $fttable.Tables[0].rows) { $null = $ftfiletable.Rows.add($ftc.Path) } } } $null = $dbfiletable.Tables.Add($ftfiletable) return $dbfiletable.Tables.Filename } $allfiles = @() $FileType += "mdf", "ldf", "ndf" $systemfiles = "distmdl.ldf", "distmdl.mdf", "mssqlsystemresource.ldf", "mssqlsystemresource.mdf" } PROCESS { foreach ($servername in $sqlserver) { $server = Connect-SqlServer -SqlServer $servername -SqlCredential $SqlCredential # Get all the database files $databasefiles = Get-SqlFileStructure -smoserver $server foreach ($file in $databasefiles) { $Path += Split-Path $file } # Get the default data and log directories from the instance $Path += $server.RootDirectory + "\DATA" $Path += Get-SqlDefaultPaths $server data $Path += Get-SqlDefaultPaths $server log $Path += $server.MasterDBPath $Path += $server.MasterDBLogPath # Clean it up $Path = $Path | ForEach-Object { $_.TrimEnd("\") } | Sort-Object -Unique # Create the file variable $orphanedfiles = @() $filesondisk = @() # Loop through each of the directories and get all the data and log file related files foreach ($directory in $Path) { $sql = "xp_dirtree '$directory', 1, 1" Write-Debug $sql $server.ConnectionContext.ExecuteWithResults($sql).Tables.Subdirectory | ForEach-Object { if ($_ -match "\.") { $ext = ($_ -split "\.")[1] if ($FileType -contains $ext -and $_ -notin $systemfiles) { $filesondisk += "$directory\$_" } } } } # Compare the two lists and save the items that are not in the database file list $orphanedfiles = (Compare-Object -ReferenceObject ($databasefiles) -DifferenceObject $filesondisk).InputObject foreach ($file in $orphanedfiles) { $allfiles += [pscustomobject]@{ Server = $server.name Filename = $file RemoteFilename = Join-AdminUnc -Servername $server.netname -Filepath $file } } } } END { $server.ConnectionContext.Disconnect() if ($LocalOnly -eq $true) { return ($allfiles | Select-Object filename).filename } if ($RemoteOnly -eq $true) { return ($allfiles | Select-Object remotefilename).remotefilename } if ($allfiles.count -eq 0) { Write-Output "No orphaned files found" } return $allfiles } } |