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 Tags: DisasterRecovery, Orphan 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/>. Thanks to Paul Randal's notes on FILESTREAM which can be found at http://www.sqlskills.com/blogs/paul/filestream-directory-structure/ .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-SQLDirTreeQuery { param ( $PathList ) # use sysaltfiles in lower versions $q1 = "CREATE TABLE #enum ( id int IDENTITY, fs_filename nvarchar(512), depth int, is_file int, parent nvarchar(512) ); DECLARE @dir nvarchar(512);" $q2 = "SET @dir = 'dirname'; INSERT INTO #enum( fs_filename, depth, is_file ) EXEC xp_dirtree @dir, 1, 1; UPDATE #enum SET parent = @dir, fs_filename = ltrim(rtrim(fs_filename)) WHERE parent IS NULL;" $query_files_sql = "SELECT e.fs_filename AS filename, e.parent FROM #enum AS e WHERE e.fs_filename NOT IN( 'xtp', '5', '`$FSLOG', '`$HKv2', 'filestream.hdr' ) AND is_file = 1;" # build the query string based on how many directories they want to enumerate $sql = $q1 $sql += $($PathList | Where-Object { $_ -ne '' } | ForEach-Object { "$([System.Environment]::Newline)$($q2 -Replace 'dirname', $_)" }) $sql += $query_files_sql Write-Debug $sql return $sql } 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" } $dbfiletable = $smoserver.ConnectionContext.ExecuteWithResults($sql) $ftfiletable = $dbfiletable.Tables[0].Clone() $dbfiletable.Tables[0].TableName = "data" # Add support for Full Text Catalogs in Sql Server 2005 and below if ($server.VersionMajor -lt 10) { $databaselist = $smoserver.Databases | select Name, IsFullTextEnabled foreach ($db in $databaselist) { if($db.IsFullTextEnabled -eq $false) { continue } $database = $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 } function Format-Path { param ($path) $path = $path.Trim() #Thank you windows 2000 $path = $path -replace '[^A-Za-z0-9 _\.\-\\:]', '__' return $path } $FileType += "mdf", "ldf", "ndf" $systemfiles = "distmdl.ldf", "distmdl.mdf", "mssqlsystemresource.ldf", "mssqlsystemresource.mdf" $FileTypeComparison = $FileType | ForEach-Object {$_.ToLower()} | Where-Object { $_ } | Sort-Object | Get-Unique } PROCESS { foreach ($servername in $sqlserver) { # Reset all the arrays $dirtreefiles = $valid = $paths = $matching = @() $server = Connect-SqlServer -SqlServer $servername -SqlCredential $SqlCredential # Get the default data and log directories from the instance Write-Debug "Adding paths" $paths += $server.RootDirectory + "\DATA" $paths += Get-SqlDefaultPaths $server data $paths += Get-SqlDefaultPaths $server log $paths += $server.MasterDBPath $paths += $server.MasterDBLogPath $paths += $Path $paths = $paths | ForEach-Object { "$_".TrimEnd("\") } | Sort-Object | Get-Unique $sql = Get-SQLDirTreeQuery $paths $datatable = $server.Databases['master'].ExecuteWithResults($sql).Tables[0] foreach ($row in $datatable) { $fullpath = [IO.Path]::combine($row.parent, $row.filename) $dirtreefiles += [pscustomobject]@{ FullPath = $fullpath Comparison = [IO.Path]::GetFullPath($(Format-Path $fullpath)) } } $dirtreefiles = $dirtreefiles | Where-Object { $_ } | Sort-Object Comparison -Unique $filestructure = Get-SqlFileStructure $server foreach ($file in $filestructure) { $valid += [IO.Path]::GetFullPath($(Format-Path $file)) } $valid = $valid | Sort-Object | Get-Unique foreach ($file in $dirtreefiles.Comparison) { foreach ($type in $FileTypeComparison) { if ($file.ToLower().EndsWith($type)) { $matching += $file break } } } $dirtreematcher = @{} foreach($el in $dirtreefiles) { $dirtreematcher[$el.Comparison] = $el.Fullpath } foreach ($file in $matching) { if ($file -notin $valid) { $fullpath = $dirtreematcher[$file] $filename = Split-Path $fullpath -Leaf if ($filename -in $systemfiles) { continue } $result = [pscustomobject]@{ Server = $server.name Filename = $fullpath RemoteFilename = Join-AdminUnc -Servername $server.netname -Filepath $fullpath } if ($LocalOnly -eq $true) { ($result | Select-Object filename).filename continue } if ($RemoteOnly -eq $true) { ($result | Select-Object remotefilename).remotefilename continue } $result } } } } END { if ($result.count -eq 0) { Write-Output "No orphaned files found" } } } |