functions/Test-DbaSqlPath.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
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle#
function Test-DbaSqlPath {
    <#
  .SYNOPSIS
   Tests if file or directory exists from the perspective of the SQL Server service account.
 
  .DESCRIPTION
   Uses master.dbo.xp_fileexist to determine if a file or directory exists.
 
  .PARAMETER SqlInstance
   The SQL Server you want to run the test on.
 
  .PARAMETER SqlCredential
    Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use:
 
   $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
 
   Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
   To connect as a different Windows user, run PowerShell as that user.
 
  .PARAMETER Path
   The Path to test. This can be a file or directory
 
  .PARAMETER EnableException
   By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
   This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
   Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
    
  .OUTPUTS
   System.Boolean
 
  .NOTES
   Tags: Path, ServiceAccount
   Author: Chrissy LeMaire (@cl), netnerds.net
   Requires: Admin access to server (not SQL Services),
   Remoting must be enabled and accessible if $SqlInstance is not local
 
   dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
   Copyright (C) 2016 Chrissy LeMaire
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .LINK
   https://dbatools.io/Test-DbaSqlPath
 
  .EXAMPLE
   Test-DbaSqlPath -SqlInstance sqlcluster -Path L:\MSAS12.MSSQLSERVER\OLAP
 
   Tests whether the service account running the "sqlcluster" SQL Server instance can access L:\MSAS12.MSSQLSERVER\OLAP. Logs into sqlcluster using Windows credentials.
 
  .EXAMPLE
   $credential = Get-Credential
   Test-DbaSqlPath -SqlInstance sqlcluster -SqlCredential $credential -Path L:\MSAS12.MSSQLSERVER\OLAP
 
   Tests whether the service account running the "sqlcluster" SQL Server instance can access L:\MSAS12.MSSQLSERVER\OLAP. Logs into sqlcluster using SQL authentication.
 
 #>

    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstance]$SqlInstance,
        [PSCredential]$SqlCredential,
        [Parameter(Mandatory = $true)]
        [string[]]$Path,
        [switch][Alias('Silent')]$EnableException
    )
    begin {
        try {
            $server = Connect-SqlInstance -SqlInstance $SqlInstance -SqlCredential $SqlCredential
        }
        catch {
            Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $SqlInstance -Continue
        }
    }
    process {
        if (Test-FunctionInterrupt) { return }
        
        $counter = [pscustomobject] @{ Value = 0 }
        $groupSize = 100
        $groups = $Path | Group-Object -Property { [math]::Floor($counter.Value++ / $groupSize) }
        foreach($g in $groups) {
            $PathsBatch = $g.Group
            $query = @()
            foreach($p in $PathsBatch) {
                $query += "EXEC master.dbo.xp_fileexist '$p'"
            }
            $sql = $query -join ';'
            $batchresult = $server.ConnectionContext.ExecuteWithResults($sql)
            if ($Path.Count -eq 1) {
                if ($batchresult.Tables.rows[0] -eq $true -or $batchresult.Tables.rows[1] -eq $true) {
                    return $true
                } else {
                    return $false
                }
            } else {
                $i = 0
                foreach($r in $batchresult.tables.rows) {
                    $DoesPass = $r[0] -eq $true -or $r[1] -eq $true
                    [pscustomobject]@{
                        FilePath   = $PathsBatch[$i]
                        FileExists = $DoesPass
                    }
                    $i += 1
                }
            }
        }
    }
    end {
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -EnableException:$false -Alias Test-SqlPath
    }
}