internal/functions/Connect-SqlInstance.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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
function Connect-SqlInstance { <# .SYNOPSIS Internal function to establish smo connections. .DESCRIPTION Internal function to establish smo connections. Can interpret any of the following types of information: - String - Smo Server objects - Smo Linked Server objects .PARAMETER SqlInstance The SQL Server instance to restore to. .PARAMETER SqlCredential Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. .PARAMETER ParameterConnection This call is for dynamic parameters only and is no longer used, actually. .PARAMETER AzureUnsupported Throw if Azure is detected but not supported .PARAMETER RegularUser The connection doesn't require SA privileges. By default, the assumption is that SA is no longer required. .PARAMETER MinimumVersion The minimum version that the calling command will support .EXAMPLE Connect-SqlInstance -SqlInstance sql2014 Connect to the Server sql2014 with native credentials. #> [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidDefaultValueSwitchParameter", "")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingEmptyCatchBlock", "")] param ( [Parameter(Mandatory = $true)][object]$SqlInstance, [object]$SqlCredential, [switch]$ParameterConnection, [switch]$RegularUser = $true, [int]$MinimumVersion, [switch]$AzureUnsupported, [switch]$NonPooled ) #region Utility functions function Invoke-TEPPCacheUpdate { [CmdletBinding()] param ( [System.Management.Automation.ScriptBlock] $ScriptBlock ) try { [ScriptBlock]::Create($scriptBlock).Invoke() } catch { # If the SQL Server version doesn't support the feature, we ignore it and silently continue if ($_.Exception.InnerException.InnerException.GetType().FullName -eq "Microsoft.SqlServer.Management.Sdk.Sfc.InvalidVersionEnumeratorException") { return } if ($ENV:APPVEYOR_BUILD_FOLDER -or ([Sqlcollaborative.Dbatools.dbaSystem.DebugHost]::DeveloperMode)) { throw } <# elseif ([Sqlcollaborative.Dbatools.dbaSystem.DebugHost]::DevelopmentBranch) { Write-Message -Level Warning -Message "Failed TEPP Caching: $($s | Select-String '"(.*?)"' | ForEach-Object { $_.Matches[0].Groups[1].Value })" -ErrorRecord $_ -EnableException $false } #> else { Write-Message -Level Warning -Message "Failed TEPP Caching: $($scriptBlock.ToString() | Select-String '"(.*?)"' | ForEach-Object { $_.Matches[0].Groups[1].Value })" -ErrorRecord $_ 3>$null } } } #endregion Utility functions #region Ensure Credential integrity <# Usually, the parameter type should have been not object but off the PSCredential type. When binding null to a PSCredential type parameter on PS3-4, it'd then show a prompt, asking for username and password. In order to avoid that and having to refactor lots of functions (and to avoid making regular scripts harder to read), we created this workaround. #> if ($SqlCredential) { if ($SqlCredential.GetType() -ne [System.Management.Automation.PSCredential]) { throw "The credential parameter was of a non-supported type! Only specify PSCredentials such as generated from Get-Credential. Input was of type $($SqlCredential.GetType().FullName)" } } #endregion Ensure Credential integrity #region Safely convert input into instance parameters <# This is a bit ugly, but: In some cases functions would directly pass their own input through when the parameter on the calling function was typed as [object[]]. This would break the base parameter class, as it'd automatically be an array and the parameterclass is not designed to handle arrays (Shouldn't have to). Note: Multiple servers in one call were never supported, those old functions were liable to break anyway and should be fixed soonest. #> if ($SqlInstance.GetType() -eq [Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter]) { [DbaInstanceParameter]$ConvertedSqlInstance = $SqlInstance if ($ConvertedSqlInstance.Type -like "SqlConnection") { [DbaInstanceParameter]$ConvertedSqlInstance = New-Object Microsoft.SqlServer.Management.Smo.Server($ConvertedSqlInstance.InputObject) } } else { [DbaInstanceParameter]$ConvertedSqlInstance = [DbaInstanceParameter]($SqlInstance | Select-Object -First 1) if ($SqlInstance.Count -gt 1) { Write-Message -Level Warning -EnableException $true -Message "More than on server was specified when calling Connect-SqlInstance from $((Get-PSCallStack)[1].Command)" } } #endregion Safely convert input into instance parameters #region Input Object was a server object if ($ConvertedSqlInstance.InputObject.GetType() -eq [Microsoft.SqlServer.Management.Smo.Server]) { $server = $ConvertedSqlInstance.InputObject if ($server.ConnectionContext.IsOpen -eq $false) { if ($NonPooled) { $server.ConnectionContext.Connect() } else { $server.ConnectionContext.SqlConnectionObject.Open() } } # Register the connected instance, so that the TEPP updater knows it's been connected to and starts building the cache [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::SetInstance($ConvertedSqlInstance.FullSmoName.ToLower(), $server.ConnectionContext.Copy(), ($server.ConnectionContext.FixedServerRoles -match "SysAdmin")) # Update cache for instance names if ([Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache["sqlinstance"] -notcontains $ConvertedSqlInstance.FullSmoName.ToLower()) { [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache["sqlinstance"] += $ConvertedSqlInstance.FullSmoName.ToLower() } # Update lots of registered stuff if (-not [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::TeppSyncDisabled) { $FullSmoName = $ConvertedSqlInstance.FullSmoName.ToLower() foreach ($scriptBlock in ([Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::TeppGatherScriptsFast)) { Invoke-TEPPCacheUpdate -ScriptBlock $scriptBlock } } return $server } #endregion Input Object was a server object #region Input Object was anything else # This seems a little complex but is required because some connections do TCP,SqlInstance $loadedSmoVersion = [AppDomain]::CurrentDomain.GetAssemblies() | Where-Object { $_.FullName -like "Microsoft.SqlServer.SMO,*" } if ($loadedSmoVersion) { $loadedSmoVersion = $loadedSmoVersion | ForEach-Object { if ($_.Location -match "__") { ((Split-Path (Split-Path $_.Location) -Leaf) -split "__")[0] } else { ((Get-ChildItem -Path $_.Location).VersionInfo.ProductVersion) } } } $server = New-Object Microsoft.SqlServer.Management.Smo.Server $ConvertedSqlInstance.FullSmoName $server.ConnectionContext.ApplicationName = "dbatools PowerShell module - dbatools.io" if ($ConvertedSqlInstance.IsConnectionString) { $server.ConnectionContext.ConnectionString = $ConvertedSqlInstance.InputObject } try { $server.ConnectionContext.ConnectTimeout = [Sqlcollaborative.Dbatools.Connection.ConnectionHost]::SqlConnectionTimeout if ($null -ne $SqlCredential.Username) { $username = ($SqlCredential.Username).TrimStart("\") if ($username -like "*\*") { $username = $username.Split("\")[1] $authtype = "Windows Authentication with Credential" $server.ConnectionContext.LoginSecure = $true $server.ConnectionContext.ConnectAsUser = $true $server.ConnectionContext.ConnectAsUserName = $username $server.ConnectionContext.ConnectAsUserPassword = ($SqlCredential).GetNetworkCredential().Password } else { $authtype = "SQL Authentication" $server.ConnectionContext.LoginSecure = $false $server.ConnectionContext.set_Login($username) $server.ConnectionContext.set_SecurePassword($SqlCredential.Password) } } } catch { } try { if ($NonPooled) { $server.ConnectionContext.Connect() } else { $server.ConnectionContext.SqlConnectionObject.Open() } } catch { $message = $_.Exception.InnerException.InnerException if ($message) { $message = $message.ToString() $message = ($message -Split '-->')[0] $message = ($message -Split 'at System.Data.SqlClient')[0] $message = ($message -Split 'at System.Data.ProviderBase')[0] if ($message -match "network path was not found") { $message = "Can't connect to $sqlinstance`: System.Data.SqlClient.SqlException (0x80131904): A network-related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that SQL Server is configured to allow remote connections." } throw "Can't connect to $ConvertedSqlInstance`: $message " } else { throw $_ } } if ($MinimumVersion -and $server.VersionMajor) { if ($server.versionMajor -lt $MinimumVersion) { throw "SQL Server version $MinimumVersion required - $server not supported." } } if ($AzureUnsupported -and $server.DatabaseEngineType -eq "SqlAzureDatabase") { throw "SQL Azure DB not supported :(" } if (-not $RegularUser) { if ($server.ConnectionContext.FixedServerRoles -notmatch "SysAdmin") { throw "Not a sysadmin on $ConvertedSqlInstance. Quitting." } } #'PrimaryFilePath' seems the culprit for slow SMO on databases $Fields2000_Db = 'Collation', 'CompatibilityLevel', 'CreateDate', 'ID', 'IsAccessible', 'IsFullTextEnabled', 'IsSystemObject', 'IsUpdateable', 'LastBackupDate', 'LastDifferentialBackupDate', 'LastLogBackupDate', 'Name', 'Owner', 'ReadOnly', 'RecoveryModel', 'ReplicationOptions', 'Status', 'Version' $Fields200x_Db = $Fields2000_Db + @('BrokerEnabled', 'IsMirroringEnabled', 'Trustworthy') $Fields201x_Db = $Fields200x_Db + @('ActiveConnections', 'AvailabilityDatabaseSynchronizationState', 'AvailabilityGroupName', 'ContainmentType', 'EncryptionEnabled') $Fields2000_Login = 'CreateDate' , 'DateLastModified' , 'DefaultDatabase' , 'DenyWindowsLogin' , 'IsSystemObject' , 'Language' , 'LanguageAlias' , 'LoginType' , 'Name' , 'Sid' , 'WindowsLoginAccessType' $Fields200x_Login = $Fields2000_Login + @('AsymmetricKey', 'Certificate', 'Credential', 'ID', 'IsDisabled', 'IsLocked', 'IsPasswordExpired', 'MustChangePassword', 'PasswordExpirationEnabled', 'PasswordPolicyEnforced') $Fields201x_Login = $Fields200x_Login + @('PasswordHashAlgorithm') if ($loadedSmoVersion -ge 11) { try { if ($Server.ServerType -ne 'SqlAzureDatabase') { $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Trigger], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Schema], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.SqlAssembly], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Table], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.View], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.StoredProcedure], 'IsSystemObject') $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.UserDefinedFunction], 'IsSystemObject') if ($server.VersionMajor -eq 8) { # 2000 $initFieldsDb = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsDb.AddRange($Fields2000_Db) $initFieldsLogin = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsLogin.AddRange($Fields2000_Login) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Database], $initFieldsDb) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Login], $initFieldsLogin) } elseif ($server.VersionMajor -eq 9 -or $server.VersionMajor -eq 10) { # 2005 and 2008 $initFieldsDb = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsDb.AddRange($Fields200x_Db) $initFieldsLogin = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsLogin.AddRange($Fields200x_Login) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Database], $initFieldsDb) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Login], $initFieldsLogin) } else { # 2012 and above $initFieldsDb = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsDb.AddRange($Fields201x_Db) $initFieldsLogin = New-Object System.Collections.Specialized.StringCollection [void]$initFieldsLogin.AddRange($Fields201x_Login) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Database], $initFieldsDb) $server.SetDefaultInitFields([Microsoft.SqlServer.Management.Smo.Login], $initFieldsLogin) } } } catch { # perhaps a DLL issue, continue going } } # Register the connected instance, so that the TEPP updater knows it's been connected to and starts building the cache [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::SetInstance($ConvertedSqlInstance.FullSmoName.ToLower(), $server.ConnectionContext.Copy(), ($server.ConnectionContext.FixedServerRoles -match "SysAdmin")) # Update cache for instance names if ([Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache["sqlinstance"] -notcontains $ConvertedSqlInstance.FullSmoName.ToLower()) { [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::Cache["sqlinstance"] += $ConvertedSqlInstance.FullSmoName.ToLower() } # Update lots of registered stuff if (-not [Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::TeppSyncDisabled) { $FullSmoName = $ConvertedSqlInstance.FullSmoName.ToLower() foreach ($scriptBlock in ([Sqlcollaborative.Dbatools.TabExpansion.TabExpansionHost]::TeppGatherScriptsFast)) { Invoke-TEPPCacheUpdate -ScriptBlock $scriptBlock } } return $server #endregion Input Object was anything else } |