functions/Test-DbaOptimizeForAdHoc.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
Function Test-DbaOptimizeForAdHoc
{
<#
.SYNOPSIS
Displays information relating to SQL Server Optimize for AdHoc Workloads setting. Works on SQL Server 2008-2016.
 
.DESCRIPTION
When this option is set, plan cache size is further reduced for single-use adhoc OLTP workload.
 
More info: https://msdn.microsoft.com/en-us/library/cc645587.aspx
http://www.sqlservercentral.com/blogs/glennberry/2011/02/25/some-suggested-sql-server-2008-r2-instance-configuration-settings/
 
These are just general recommendations for SQL Server and are a good starting point for setting the "optimize for adhoc workloads" option.
 
.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.
 
.NOTES
Author: Brandon Abshire, netnerds.net
 
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/Test-DbaOptimizeAdHoc
 
.EXAMPLE
Test-DbaOptimizeAdHoc -SqlServer sql2008, sqlserver2012
Get Optimize for AdHoc Workloads setting for servers sql2008 and sqlserver2012 and also the recommended one.
 
#>

[CmdletBinding()]
Param (
[parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
[Alias("ServerInstance", "SqlInstance", "SqlServers")]
[string[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential
)

BEGIN
{
        $notesAdHocZero = "Recommended configuration is 1"
$notesAsRecommended = "Configuration is as recommended"
}

PROCESS
{

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

if ($server.versionMajor -lt 10)
{
Write-Warning "This function does not support versions lower than SQL Server 2008 (v10). Skipping server $servername."

Continue
}

#Get current configured value
            $optimizeAdHoc = $server.Configuration.OptimizeAdhocWorkloads.ConfigValue


#Setting notes for optimize adhoc value
if ($optimizeAdHoc -eq 1)
{
$notes = $notesAsRecommended
}
else
{
$notes = $notesAdHocZero
}

[pscustomobject]@{
Instance = $server.Name
CurrentOptimizeAdHoc = $optimizeAdHoc
         RecommendedOptimizeAdHoc = 1
Notes = $notes
}
}
}
}