< Back
Get-DbaDbQueryStoreOption
Post
NAME Get-DbaDbQueryStoreOption
SYNOPSIS
Get the Query Store configuration for Query Store enabled databases.
SYNTAX
Get-DbaDbQueryStoreOption [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves and returns the Query Store configuration for every database that has the Query Store feature enabled.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.Object[]>]
The database(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
SqlLogin to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance..
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.SqlServer.Management.Smo.QueryStoreOptions
NOTES
Tags: QueryStore
Author: Enrico van de Laar (@evdlaar) | Klaas Vandenberghe (@PowerDBAKlaas) | Tracy Boggiano (@TracyBoggiano)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance ServerA\\sql
Returns Query Store configuration settings for every database on the ServerA\\sql instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance 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 3 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance localhost | format-table -AutoSize -Wrap
Returns Query Store configuration settings for every database on the ServerA\\sql instance inside a table format.
RELATED LINKS
https://dbatools.io/Get-DbaQueryStoreOptions
SYNOPSIS
Get the Query Store configuration for Query Store enabled databases.
SYNTAX
Get-DbaDbQueryStoreOption [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>]
[-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Retrieves and returns the Query Store configuration for every database that has the Query Store feature enabled.
PARAMETERS
-Database [<System.Object[]>]
The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will
be processed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ExcludeDatabase [<System.Object[]>]
The database(s) to exclude - this list is auto-populated from the server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
SqlLogin to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance..
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Microsoft.SqlServer.Management.Smo.QueryStoreOptions
NOTES
Tags: QueryStore
Author: Enrico van de Laar (@evdlaar) | Klaas Vandenberghe (@PowerDBAKlaas) | Tracy Boggiano (@TracyBoggiano)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance ServerA\\sql
Returns Query Store configuration settings for every database on the ServerA\\sql instance.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance 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 3 --------------------------
PS C:\\>Get-DbaDbQueryStoreOption -SqlInstance localhost | format-table -AutoSize -Wrap
Returns Query Store configuration settings for every database on the ServerA\\sql instance inside a table format.
RELATED LINKS
https://dbatools.io/Get-DbaQueryStoreOptions