functions/Get-DbaDependency.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
function Get-DbaDependency { <# .SYNOPSIS Finds object dependencies and their relevant creation scripts. .DESCRIPTION This function recursively finds all objects that depends on the input. It will then retrieve rich information from them, including their creation scripts and the order in which it should be applied. By using the 'Parents' switch, the function will instead retrieve all items that the input depends on (including their creation scripts). For more details on dependency, see: https://technet.microsoft.com/en-us/library/ms345449(v=sql.105).aspx .PARAMETER InputObject The SMO object to parse .PARAMETER AllowSystemObjects Normally, system objects are ignored by this function as dependencies. This switch overrides that behavior. .PARAMETER Parents Causes the function to retrieve all objects that the input depends on, rather than retrieving everything that depends on the input. .PARAMETER IncludeSelf Includes the object whose dependencies are retrieves itself. Useful when exporting an entire logic structure in order to recreate it in another database. .PARAMETER Silent Replaces user friendly yellow warnings with bloody red exceptions of doom! Use this if you want the function to throw terminating errors you want to catch. .PARAMETER IncludeScript Setting this switch will cause the function to also retrieve the creation script of the dependency. .EXAMPLE $table = (Get-DbaDatabase -SqlInstance sql2012 Northwind).tables | Where Name -eq Customers $table | Get-DbaDependency Returns everything that depends on the "Customers" table .LINK https://dbatools.io/Get-DbaDependency #> [CmdletBinding()] Param ( [Parameter(ValueFromPipeline = $true)] $InputObject, [switch] $AllowSystemObjects, [switch] $Parents, [switch] $IncludeSelf, [switch] $Silent ) Begin { #region Utility functions function Get-DependencyTree { [CmdletBinding()] Param ( $Object, $Server, [bool] $AllowSystemObjects, [bool] $EnumParents, [string] $FunctionName, [bool] $Silent ) $scripter = New-Object Microsoft.SqlServer.Management.Smo.Scripter $options = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions $options.DriAll = $true $options.AllowSystemObjects = $AllowSystemObjects $options.WithDependencies = $true $scripter.Options = $options $scripter.Server = $Server $urnCollection = New-Object Microsoft.SqlServer.Management.Smo.UrnCollection Write-Message -Silent $Silent -Level 5 -Message "Adding $Object which is a $($Object.urn.Type)" -FunctionName $FunctionName $urnCollection.Add([Microsoft.SqlServer.Management.Sdk.Sfc.Urn]$Object.urn) #now we set up an event listnenr go get progress reports $progressReportEventHandler = [Microsoft.SqlServer.Management.Smo.ProgressReportEventHandler] { $name = $_.Current.GetAttribute('Name'); Write-Message -Silent $Silent -Level 5 -Message "Analysed $name" -FunctionName $FunctionName } $scripter.add_DiscoveryProgress($progressReportEventHandler) return $scripter.DiscoverDependencies($urnCollection, $EnumParents) } function Read-DependencyTree { [CmdletBinding()] Param ( [System.Object] $InputObject, [int] $Tier, [System.Object] $Parent, [bool] $EnumParents ) Add-Member -InputObject $InputObject -Name Parent -Value $Parent -MemberType NoteProperty if ($EnumParents) { Add-Member -InputObject $InputObject -Name Tier -Value ($Tier * -1) -MemberType NoteProperty -PassThru } else { Add-Member -InputObject $InputObject -Name Tier -Value $Tier -MemberType NoteProperty -PassThru } if ($InputObject.HasChildNodes) { Read-DependencyTree -InputObject $InputObject.FirstChild -Tier ($Tier + 1) -Parent $InputObject -EnumParents $EnumParents } if ($InputObject.NextSibling) { Read-DependencyTree -InputObject $InputObject.NextSibling -Tier $Tier -Parent $Parent -EnumParents $EnumParents } } function Get-DependencyTreeNodeDetail { [CmdletBinding()] Param ( [Parameter(ValueFromPipeline = $true)] $SmoObject, $Server, $OriginalResource, [bool] $AllowSystemObjects ) Begin { $scripter = New-Object Microsoft.SqlServer.Management.Smo.Scripter $options = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions $options.DriAll = $true $options.AllowSystemObjects = $AllowSystemObjects $options.WithDependencies = $true $scripter.Options = $options $scripter.Server = $Server } process { foreach ($Item in $SmoObject) { $richobject = $Server.GetSmoObject($Item.urn) $parent = $Server.GetSmoObject($Item.Parent.Urn) $NewObject = New-Object sqlcollective.dbatools.Database.Dependency $NewObject.ComputerName = $server.NetName $NewObject.ServiceName = $server.ServiceName $NewObject.SqlInstance = $server.DomainInstanceName $NewObject.Dependent = $richobject.Name $NewObject.Type = $Item.Urn.Type $NewObject.Owner = $richobject.Owner $NewObject.IsSchemaBound = $Item.IsSchemaBound $NewObject.Parent = $parent.Name $NewObject.ParentType = $parent.Urn.Type $NewObject.Tier = $Item.Tier $NewObject.Object = $richobject $NewObject.Urn = $richobject.Urn $NewObject.OriginalResource = $OriginalResource $SQLscript = $scripter.EnumScriptWithList($richobject) # I can't remember how to remove these options and their syntax is breaking stuff $SQLscript = $SQLscript -replace "SET ANSI_NULLS ON", "" $SQLscript = $SQLscript -replace "SET QUOTED_IDENTIFIER ON", "" $NewObject.Script = "$SQLscript `r`ngo" $NewObject } } } function Select-DependencyPrecedence { [CmdletBinding()] Param ( [Parameter(ValueFromPipeline = $true)] $Dependency ) Begin { $list = @() } Process { foreach ($dep in $Dependency) { # Killing the pipeline is generally a bad idea, but since we have to group and sort things, we have not really a choice $list += $dep } } End { $list | Group-Object -Property Object | ForEach-Object { $_.Group | Sort-Object -Property Tier -Descending | Select-Object -First 1 } | Sort-Object Tier } } #endregion Utility functions } Process { foreach ($Item in $InputObject) { Write-Message -Silent $Silent -Level 5 -Message "Processing: $Item" if ($null -eq $Item.urn) { Stop-Function -Message "$Item is not a valid SMO object" -Silent $Silent -Category InvalidData -Continue -Target $Item } # Find the server object to pass on to the function $parent = $Item.parent do { $parent = $parent.parent } until (($parent.urn.type -eq "Server") -or (-not $parent)) if (-not $parent) { Stop-Function -Message "Failed to find valid server object in input: $Item" -Silent $Silent -Category InvalidData -Continue -Target $Item } $server = $parent $tree = Get-DependencyTree -Object $Item -AllowSystemObjects $false -Server $server -FunctionName (Get-PSCallStack)[0].COmmand -Silent $Silent -EnumParents $Parents $limitCount = 2 if ($IncludeSelf) { $limitCount = 1 } if ($tree.Count -lt $limitCount) { Write-Message -Message "No dependencies detected for $($Item)" -Level 2 -Silent $Silent continue } if ($IncludeSelf) { $resolved = Read-DependencyTree -InputObject $tree.FirstChild -Tier 0 -Parent $tree.FirstChild -EnumParents $Parents } else { $resolved = Read-DependencyTree -InputObject $tree.FirstChild.FirstChild -Tier 1 -Parent $tree.FirstChild -EnumParents $Parents } $resolved | Get-DependencyTreeNodeDetail -Server $server -OriginalResource $Item -AllowSystemObjects $AllowSystemObjects | Select-DependencyPrecedence } } } |