functions/Get-DbaQueryStoreConfig.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
Function Get-DbaQueryStoreConfig
{
<#
.SYNOPSIS
Get the Query Store configuration for Query Store enabled databases.
  
.DESCRIPTION
Retrieves and returns the Query Store configuration for every database that has the Query Store feature enabled.
  
.PARAMETER SqlInstance
The SQL Server that you're connecting to.
 
.PARAMETER SqlCredential
SqlCredential object used to connect to the SQL Server as a different user.
 
.PARAMETER Databases
Return information for only specific databases
 
.PARAMETER Exclude
Return information for all but these specific databases
 
.NOTES
Author: Enrico van de Laar ( @evdlaar )
Tags: QueryStore
dbatools PowerShell module (https://dbatools.io)
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/Get-QueryStoreConfig
 
.EXAMPLE
Get-DbaQueryStoreConfig -SqlServer ServerA\sql
 
Returns Query Store configuration settings for every database on the ServerA\sql instance.
 
.EXAMPLE
Get-DbaQueryStoreConfig -SqlServer ServerA\sql | Where-Object {$_.ActualState -eq "ReadWrite"}
 
Returns the Query Store configuration for all databases on ServerA\sql where the Query Store feature is in Read/Write mode.
 
.EXAMPLE
Get-DbaQueryStoreConfig -SqlServer localhost | format-table -AutoSize -Wrap
 
Returns Query Store configuration settings for every database on the ServerA\sql instance inside a table format.
  
#>

    [CmdletBinding()]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [object[]]$SqlInstance,
        [System.Management.Automation.PSCredential]$SqlCredential
    )
    
    DynamicParam
    {
        if ($SqlInstance)
        {
            Get-ParamSqlDatabases -SqlServer $SqlInstance[0] -SqlCredential $SqlCredential
        }
    }
    
    BEGIN
    {
        # Convert from RuntimeDefinedParameter object to regular array
        $databases = $psboundparameters.Databases
        $exclude = $psboundparameters.Exclude
    }
    
    PROCESS
    {
        foreach ($instance in $SqlInstance)
        {
            Write-Verbose "Connecting to $instance"
            try
            {
                $server = Connect-SqlServer -SqlServer $instance -SqlCredential $SqlCredential
                
            }
            catch
            {
                Write-Warning "Can't connect to $instance. Moving on."
                continue
            }
            
            if ($server.VersionMajor -lt 13)
            {
                Write-Warning "The SQL Server Instance ($instance) has a lower SQL Server version than SQL Server 2016. Skipping server."
                continue
            }
            
            
            # We have to exclude all the system databases since they cannot have the Query Store feature enabled
            $dbs = $server.Databases | Where-Object { $_.IsSystemObject -eq $false }
            
            if ($databases.count -gt 0)
            {
                $dbs = $dbs | Where-Object { $databases -contains $_.Name }
            }
            
            if ($exclude.count -gt 0)
            {
                $dbs = $dbs | Where-Object { $exclude -notcontains $_.Name }
            }
            
            
            foreach ($db in $dbs)
            {
                Write-Verbose "Processing $db on $instance"
                
                if ($db.IsAccessible -eq $false)
                {
                    Write-Warning "The database $db on server $instance is not accessible. Skipping database."
                    Continue
                }
                
                [pscustomobject]@{
                    Instance = $instance.name
                    Database = $db.name
                    ActualState = $db.QueryStoreOptions.ActualState
                    FlushInterval = $db.QueryStoreOptions.DataFlushIntervalInSeconds
                    CollectionInterval = $db.QueryStoreOptions.StatisticsCollectionIntervalInMinutes
                    MaxSize = $db.QueryStoreOptions.MaxStorageSizeInMB
                    CurrentSize = $db.QueryStoreOptions.CurrentStorageSizeInMB
                    CaptureMode = $db.QueryStoreOptions.QueryCaptureMode
                    CleanupMode = $db.QueryStoreOptions.SizeBasedCleanupMode
                    StaleQueryThreshold = $db.QueryStoreOptions.StaleQueryThresholdInDays
                }
            }
        }
    }
}