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
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
 
        Related Docs, Pull Requests and Issues:
 
    Connect commands and alt Windows Credential fix
    https://github.com/sqlcollaborative/dbatools/pull/3835
 
    Connect-*Instance, fix errors with Windows logins
    https://github.com/sqlcollaborative/dbatools/pull/4426
 
    Invoke-DbaSqlQuery fails to use proper Windows credentials
    https://github.com/sqlcollaborative/dbatools/issues/3780
 
    Fixed auth issue
    https://github.com/sqlcollaborative/dbatools/pull/3809
 
    Connecting to an Instance of SQL Server
    https://docs.microsoft.com/en-us/sql/relational-databases/server-management-objects-smo/create-program/connecting-to-an-instance-of-sql-server
 
    SQL Server Connection Pooling (ADO.NET)
    https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/sql-server-connection-pooling
 
    .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 MinimumVersion
       The minimum version that the calling command will support
 
    .PARAMETER StatementTimeout
        Sets the number of seconds a statement is given to run before failing with a timeout error.
 
    .EXAMPLE
        Connect-SqlInstance -SqlInstance sql2014
 
        Connect to the Server sql2014 with native credentials.
    #>

    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [DbaInstanceParameter]$SqlInstance,
        [PSCredential]$SqlCredential,
        [int]$StatementTimeout,
        [int]$MinimumVersion,
        [switch]$AzureUnsupported,
        [switch]$NonPooled
    )
    if ($SqlInstance.InputObject.GetType().Name -eq 'Server') {
        if ($AzureUnsupported -and $server.DatabaseEngineType -eq "SqlAzureDatabase") {
            throw "Azure SQL Database is not supported by this command"
        }
        return $SqlInstance.InputObject
    } else {
        Connect-DbaInstance @PSBoundParameters -ClientName (Get-DbatoolsConfigValue -FullName 'sql.connection.clientname')
    }
}