functions/Set-DbaMaxDop.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
308
309
310
311
312
313
314
315
Function Set-DbaMaxDop
{
<#
.SYNOPSIS
Sets SQL Server max dop then displays information relating to SQL Server Max DOP configuration settings. Works on SQL Server 2005-2016.
 
.DESCRIPTION
Uses the Test-DbaMaxDop command to get the recommended value if -MaxDop parameter is not specified.
 
These are just general recommendations for SQL Server and are a good starting point for setting the "max degree of parallelism" option.
You can set MaxDop database scoped configurations if the server is version 2016.
 
THIS CODE IS PROVIDED "AS IS", WITH NO WARRANTIES.
 
.PARAMETER SqlServer
Allows you to specify a comma separated list of servers to query.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$cred = Get-Credential, this pass this $cred to the param.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER MaxDop
Allows you to specify the MaxDop value that you want to use.
 
.PARAMETER AllDatabases
This is a parameter that was included so you can set MaxDop value to all databases. Only valid when using on SQL Server 2016 instances.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.PARAMETER Collection
Results of Test-SQLMaxDop to be passed into the command
 
.NOTES
Author : Cláudio Silva (@claudioessilva)
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/>.
 
.LINK
https://dbatools.io/Set-DbaMaxDop
 
.EXAMPLE
Set-DbaMaxDop -SqlServer sql2008, sql2012
 
Set recommended Max DOP setting for servers sql2008 and sql2012.
 
.EXAMPLE
Set-DbaMaxDop -SqlServer sql2014 -MaxDop 4
 
Set Max DOP setting to 4 for server sql2014.
 
.EXAMPLE
Test-DbaMaxDop -SqlServer sql2008 | Set-DbaMaxDop
 
Get Max DOP recommended setting from Test-DbaMaxDop and applies to sql2008 instance
 
.EXAMPLE
Set-DbaMaxDop -SqlServer sql2016 -Databases db1
 
Set recommended Max DOP setting database db1 on server sql2016.
 
.EXAMPLE
Set-DbaMaxDop -SqlServer sql2016 -AllDatabases
 
Set recommended Max DOP setting for all databases on server sql2016.
  
 
#>

[CmdletBinding(SupportsShouldProcess = $true)]
Param (
[parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
[Alias("ServerInstance", "SqlInstance", "SqlServers")]
[string[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential,
[int]$MaxDop = -1,
[Parameter(ValueFromPipeline = $True)]
[object]$Collection,
        [Alias("All")]
        [switch]$AllDatabases
)

DynamicParam { if ($SqlServer) { return Get-ParamSqlDatabases -SqlServer $SqlServer[0] -SqlCredential $SourceSqlCredential } }

BEGIN
{
$databases = $psboundparameters.Databases

        if ($databases -gt 0 -and $AllDatabases)
        {
            throw "-Databases and -AllDatabases are mutually exclusive. Please choose only one. Quitting"
        }

$processed = New-Object System.Collections.ArrayList
        $results = @()
}
PROCESS
{
        $dbscopedconfiguration = $false

if ($MaxDop -eq -1)
{
$UseRecommended = $true
}

if ($collection -eq $null)
{
$collection = Test-DbaMaxDop -SqlServer $SqlServer -SqlCredential $SqlCredential -Verbose:$false
}
elseif ($collection.Instance -eq $null)
{
$collection = Test-DbaMaxDop -SqlServer $SqlServer -SqlCredential $SqlCredential -Verbose:$false
}

$collection | Add-Member -NotePropertyName OldInstanceMaxDopValue -NotePropertyValue 0
$collection | Add-Member -NotePropertyName OldDatabaseMaxDopValue -NotePropertyValue 0

$servers = $collection | Select-Object Instance -Unique

foreach ($server in $servers)
{
if ($server.Instance -ne $null)
{
$servername = $server.Instance
}
else
{
$servername = $server
}

Write-Verbose "Attempting to connect to $servername"
try
{
$server = Connect-SqlServer -SqlServer $servername -SqlCredential $SqlCredential
}
catch
{
Write-Warning "Can't connect to $server or access denied. Skipping."
continue
}

if (!(Test-SqlSa -SqlServer $server))
{
Write-Error "Not a sysadmin on $server. Skipping."
$server.ConnectionContext.Disconnect()
continue
}

            if ($server.versionMajor -ge 13)
    {
                
    Write-Verbose "Server '$servername' supports Max DOP configuration per database."

                if ($databases -eq 0)
                {
                    #Set at instance level
                    $collection = $collection | Where-Object { $_.DatabaseMaxDop -eq "N/A" }
                }
                else
                {
                    $dbscopedconfiguration = $true

                    if (!$AllDatabases -and $databases -gt 0)
                    {
                        
                        $collection = $collection | Where-Object { $_.Database -in $databases }
                    }
                    else
                    {
                        if ($AllDatabases)
                        {
                            $collection = $collection | Where-Object { $_.DatabaseMaxDop -ne "N/A" }
                        }
                        else
                        {
                            $collection = $collection | Where-Object { $_.DatabaseMaxDop -eq "N/A" }
                            $dbscopedconfiguration = $false
                        }
                    }
                }
            }
            else
            {
                if ($databases -gt 0 -or $AllDatabases)
                {
                    Write-Warning "Server '$servername' (v$($server.versionMajor)) does not support Max DOP configuration at the database level. Remember that this option is only available from SQL Server 2016 (v13). Run the command again without using database related parameters. Skipping."
    Continue
    }
            }

foreach ($row in $collection | Where-Object { $_.Instance -eq $servername })
{
if ($UseRecommended -and ($row.RecommendedMaxDop -eq $row.CurrentInstanceMaxDop) -and !($dbscopedconfiguration))
                {
                    Write-Output "$servername is configured properly :) No change required."
                    Continue
                }

                if ($UseRecommended -and ($row.RecommendedMaxDop -eq $row.DatabaseMaxDop) -and $dbscopedconfiguration)
                {
                    Write-Output "Database $($row.Database) on $servername is configured properly :) No change required."
                    Continue
                }

$row.OldInstanceMaxDopValue = $row.CurrentInstanceMaxDop

try
{
if ($UseRecommended)
{
if ($dbscopedconfiguration)
{
$row.OldDatabaseMaxDopValue = $row.DatabaseMaxDop

if ($resetDatabases)
{
Write-Verbose "Changing $($row.Database) database max DOP to $($row.DatabaseMaxDop)."
$server.Databases["$($row.Database)"].MaxDop = $row.DatabaseMaxDop
}
else
{
Write-Verbose "Changing $($row.Database) database max DOP from $($row.DatabaseMaxDop) to $($row.RecommendedMaxDop)"
$server.Databases["$($row.Database)"].MaxDop = $row.RecommendedMaxDop
$row.DatabaseMaxDop = $row.RecommendedMaxDop
}

}
else
{
Write-Verbose "Changing $server SQL Server max DOP from $($row.CurrentInstanceMaxDop) to $($row.RecommendedMaxDop)"
$server.Configuration.MaxDegreeOfParallelism.ConfigValue = $row.RecommendedMaxDop
$row.CurrentInstanceMaxDop = $row.RecommendedMaxDop
}
}
else
{
if ($dbscopedconfiguration)
{
                            $row.OldDatabaseMaxDopValue = $row.DatabaseMaxDop

Write-Verbose "Changing $($row.Database) database max DOP from $($row.DatabaseMaxDop) to $MaxDop"
$server.Databases["$($row.Database)"].MaxDop = $MaxDop
$row.DatabaseMaxDop = $MaxDop
}
else
{
Write-Verbose "Changing $servername SQL Server max DOP from $($row.CurrentInstanceMaxDop) to $MaxDop"
$server.Configuration.MaxDegreeOfParallelism.ConfigValue = $MaxDop
$row.CurrentInstanceMaxDop = $MaxDop
}
}

if ($dbscopedconfiguration)
{
if ($Pscmdlet.ShouldProcess($row.Database, "Setting max dop on database"))
{
$server.Databases["$($row.Database)"].Alter()
}
}
else
{
if ($Pscmdlet.ShouldProcess($servername, "Setting max dop on instance"))
{
$server.Configuration.Alter()
}
}

$results += [pscustomobject]@{
Instance = $row.Instance
InstanceVersion = $row.InstanceVersion
Database = $row.Database
DatabaseMaxDop = $row.DatabaseMaxDop
CurrentInstanceMaxDop = $row.CurrentInstanceMaxDop
RecommendedMaxDop = $row.RecommendedMaxDop
OldDatabaseMaxDopValue = $row.OldDatabaseMaxDopValue
OldInstanceMaxDopValue = $row.OldInstanceMaxDopValue
}
}
catch { Write-Error "Could not modify Max Degree of Paralellism for $server." }
}

$server.ConnectionContext.Disconnect()
}

}
    END
    {

if ($Pscmdlet.ShouldProcess("console", "Showing finished message"))
{
if ($dbscopedconfiguration)
{
return $results | Select-Object Instance, Database, OldDatabaseMaxDopValue, @{ name = "CurrentDatabaseMaxDopValue"; expression = { $_.DatabaseMaxDop } }
}
else
{
return $results | Select-Object Instance, OldInstanceMaxDopValue, CurrentInstanceMaxDop
}
}
    }
}