Downloads:
192,712
Downloads of v 0.9.419:
190
Last Update:
14 Sep 2018
Package Maintainer(s):
Software Author(s):
- Chrissy LeMaire
Tags:
admin powershell module template dba sqlserver sql tools database- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
dbatools (PowerShell Module)
This is not the latest version of dbatools (PowerShell Module) available.
- 1
- 2
- 3
0.9.419 | Updated: 14 Sep 2018
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
192,712
Downloads of v 0.9.419:
190
Maintainer(s):
Software Author(s):
- Chrissy LeMaire
dbatools (PowerShell Module) 0.9.419
This is not the latest version of dbatools (PowerShell Module) available.
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by Chrissy LeMaire. The inclusion of Chrissy LeMaire trademark(s), if any, upon this webpage is solely to identify Chrissy LeMaire goods or services and not for commercial purposes.
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install dbatools (PowerShell Module), run the following command from the command line or from PowerShell:
To upgrade dbatools (PowerShell Module), run the following command from the command line or from PowerShell:
To uninstall dbatools (PowerShell Module), run the following command from the command line or from PowerShell:
Deployment Method:
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download dbatools --internalize --version=0.9.419 --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade dbatools -y --source="'INTERNAL REPO URL'" --version="'0.9.419'" [other options]
See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade dbatools -y --source="'INTERNAL REPO URL'" --version="'0.9.419'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install dbatools
win_chocolatey:
name: dbatools
version: '0.9.419'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'dbatools' do
action :install
source 'INTERNAL REPO URL'
version '0.9.419'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller dbatools
{
Name = "dbatools"
Version = "0.9.419"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'dbatools':
ensure => '0.9.419',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
This package was approved as a trusted package on 14 Sep 2018.
dbatools logo dbatools is sort of like a command-line SQL Server Management Studio. The project initially started out as Start-SqlMigration.ps1, but has now grown into a collection of over 300 commands that help automate SQL Server tasks and encourage best practices.
NOTE: This module requires a minimum of PowerShell v3.
NOTE: This is an automatically updated package. If you find it is out of date by more than a week, please contact the maintainer(s) and let them know the package is no longer updating correctly.
md5: 0A263CE4A3000CCC9233910FA81A0505 | sha1: 9DC0FECF034A40787EC087FCEE48F168C90631CC | sha256: B7F1F2EAF736A7AB0299D03E58DE52CED0E9EAA6731E21D5587E85C1829825A6 | sha512: 16D4B169CF832BC6C6603E61278B0BF320E2D800460A3AE8D13C9BE26A381038AB9617B1A82988749A2880518944DCB19166E46F864A081D20853FE9D0275533
<Objs Version="1.1.0.1" xmlns="http://schemas.microsoft.com/powershell/2004/04">
<Obj RefId="0">
<TN RefId="0">
<T>Deserialized.System.Management.Automation.PSCustomObject</T>
<T>Deserialized.System.Object</T>
</TN>
<MS>
<S N="Name">Long Running Queries</S>
<S N="Source">Brad McGehee</S>
</MS>
</Obj>
<Obj RefId="1">
<TNRef RefId="0" />
<MS>
<S N="Name">PAL - SQL Server 2005</S>
<S N="Source">Clint Huffman</S>
</MS>
</Obj>
<Obj RefId="2">
<TNRef RefId="0" />
<MS>
<S N="Name">PAL - SQL Server 2008 and R2</S>
<S N="Source">Clint Huffman</S>
</MS>
</Obj>
<Obj RefId="3">
<TNRef RefId="0" />
<MS>
<S N="Name">PAL - SQL Server 2012</S>
<S N="Source">Clint Huffman</S>
</MS>
</Obj>
<Obj RefId="4">
<TNRef RefId="0" />
<MS>
<S N="Name">PAL - SQL Server 2014 and Up</S>
<S N="Source">Clint Huffman</S>
</MS>
</Obj>
</Objs>
# Current library Version the module expects
$currentLibraryVersion = New-Object System.Version(0, 10, 0, 57)
<#
Library Versioning 101:
The version consists of 4 segments: Major, Minor, Build, Revision
Major: Should always be equal to the main version number of the dbatools PowerShell project.
Minor: Tracks major features within a major release. Increment on new features or significant structural changes. Reset to 0 when incrementing the major version.
Build: Tracks lesser functionality upgrades. Increment on all minor upgrades, reset to 0 when introducing a new major feature or major version.
Revision: Tracks all changes. Every single update to the library - bugfix, feature or redesign - increments the revision counter. It is never reset to 0.
Updating the library version number:
When changing the library version number, it is necessary to do so in TWO places:
- At the top of this very library.ps1
- Within AssemblyInfo.cs
These two locations MUST have matching version numbers, otherwise it will keep building the library and complaining about version mismatch!
#>
<#
#---------------------------------#
# Runtime configuration variables #
#---------------------------------#
The library recognizes a few external variables in order to customize its behavior on import.
$dbatools_strictsecuritymode
Setting this to $true will cause dbatools to always load the library directly from the module directory.
This is more secure, but less convenient when it comes to updating the module, as all consoles using it must be closed.
$dbatools_alwaysbuildlibrary
Setting this to $true will cause the module to always build the library from source, rather than reuse the binaries.
Mostly for developers working on the library.
#>
#region Test whether the module had already been imported
if (([System.Management.Automation.PSTypeName]'Sqlcollaborative.Dbatools.Configuration.Config').Type) {
# No need to load the library again, if the module was once already imported.
Write-Verbose -Message "Library already loaded, will not load again"
$ImportLibrary = $false
}
else {
Write-Verbose -Message "Library not present already, will import"
$ImportLibrary = $true
}
#endregion Test whether the module had already been imported
if ($ImportLibrary) {
#region Add Code
try {
$libraryBase = $ExecutionContext.SessionState.Module.ModuleBase + "\bin"
# In strict security mode, only load from the already pre-compiled binary within the module
if ($script:strictSecurityMode) {
if (Test-Path -Path "$libraryBase\dbatools.dll") {
Add-Type -Path "$libraryBase\dbatools.dll" -ErrorAction Stop
}
else {
throw "Library not found, terminating!"
}
}
# Else we prioritize user convenience
else {
$hasProject = Test-Path -Path "$libraryBase\projects\dbatools\dbatools.sln"
$hasCompiledDll = Test-Path -Path "$libraryBase\dbatools.dll"
if ((-not $script:alwaysBuildLibrary) -and $hasCompiledDll -and ([System.Diagnostics.FileVersionInfo]::GetVersionInfo("$libraryBase\dbatools.dll").FileVersion -eq $currentLibraryVersion)) {
$start = Get-Date
try {
Write-Verbose -Message "Found library, trying to copy & import"
if ($libraryBase -ne $script:DllRoot) { Copy-Item -Path "$libraryBase\dbatools.dll" -Destination $script:DllRoot -Force -ErrorAction Stop }
Add-Type -Path "$script:DllRoot\dbatools.dll" -ErrorAction Stop
}
catch {
Write-Verbose -Message "Failed to copy&import, attempting to import straight from the module directory"
Add-Type -Path "$libraryBase\dbatools.dll" -ErrorAction Stop
}
Write-Verbose -Message "Total duration: $((Get-Date) - $start)"
}
elseif ($hasProject) {
"$($PSScriptRoot)\build-project.ps1"
}
else {
throw "No valid dbatools library found! Check your module integrity"
}
}
#region PowerShell TypeData
Update-TypeData -TypeName "Sqlcollaborative.Dbatools.dbaSystem.DbatoolsException" -SerializationDepth 2 -ErrorAction Ignore
Update-TypeData -TypeName "Sqlcollaborative.Dbatools.dbaSystem.DbatoolsExceptionRecord" -SerializationDepth 2 -ErrorAction Ignore
#endregion PowerShell TypeData
}
catch {
#region Warning
Write-Warning @'
Dear User,
in the name of the dbatools team I apologize for the inconvenience.
Generally, when something goes wrong we try to handle and interpret in an
understandable manner. Unfortunately, something went awry with importing
our main library, so all the systems making this possible would not be initialized
yet. We have taken great pains to avoid this issue but this notification indicates
we have failed.
Please, in order to help us prevent this from happening again, visit us at:
https://github.com/sqlcollaborative/dbatools/issues
and tell us about this failure. All information will be appreciated, but
especially valuable are:
- Exports of the exception: $Error | Export-Clixml error.xml -Depth 4
- Screenshots
- Environment information (Operating System, Hardware Stats, .NET Version,
PowerShell Version and whatever else you may consider of potential impact.)
Again, I apologize for the inconvenience and hope we will be able to speedily
resolve the issue.
Best Regards,
Friedrich Weinmann
aka "The guy who made most of The Library that Failed to import"
'@
throw
#endregion Warning
}
#endregion Add Code
}
#region Version Warning
if ($currentLibraryVersion -ne ([version](([AppDomain]::CurrentDomain.GetAssemblies() | Where-Object ManifestModule -like "dbatools.dll").CustomAttributes | Where-Object AttributeType -like "System.Reflection.AssemblyFileVersionAttribute").ConstructorArguments.Value)) {
Write-Warning @"
A version missmatch between the dbatools library loaded and the one expected by
this module. This usually happens when you update the dbatools module and use
Remove-Module / Import-Module in order to load the latest version without
starting a new PowerShell instance.
Please restart the console to apply the library update, or unexpected behavior will likely occur.
If the issues continue to persist, please Remove-Item '$script:PSModuleRoot\bin\dbatools.dll'
"@
}
#endregion Version Warning
<DataCollectorSet>
<Name>PAL - SQL Server 2005</Name>
<DisplayName>PAL - SQL Server 2005</DisplayName>
<DisplayNameUnresolved>PAL - SQL Server 2005</DisplayNameUnresolved>
<Description>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</Description>
<DescriptionUnresolved>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</DescriptionUnresolved>
<SubdirectoryFormat>3</SubdirectoryFormat>
<SubdirectoryFormatPattern>yyyyMMdd\-NNNNNN</SubdirectoryFormatPattern>
<PerformanceCounterDataCollector>
<Name>PAL - SQL Server 2005 Collector</Name>
<SampleInterval>15</SampleInterval>
<Counter>\Cache\Dirty Pages</Counter>
<Counter>\Cache\Lazy Write Flushes/sec</Counter>
<Counter>\LogicalDisk(*)\% Free Space</Counter>
<Counter>\LogicalDisk(*)\% Idle Time</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Write</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\LogicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Reads/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Transfers/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Writes/sec</Counter>
<Counter>\LogicalDisk(*)\Free Megabytes</Counter>
<Counter>\Memory\% Committed Bytes In Use</Counter>
<Counter>\Memory\Available MBytes</Counter>
<Counter>\Memory\Commit Limit</Counter>
<Counter>\Memory\Committed Bytes</Counter>
<Counter>\Memory\Free & Zero Page List Bytes</Counter>
<Counter>\Memory\Free System Page Table Entries</Counter>
<Counter>\Memory\Long-Term Average Standby Cache Lifetime (s)</Counter>
<Counter>\Memory\Pages Input/sec</Counter>
<Counter>\Memory\Pages Output/sec</Counter>
<Counter>\Memory\Pages/sec</Counter>
<Counter>\Memory\Pool Nonpaged Bytes</Counter>
<Counter>\Memory\Pool Paged Bytes</Counter>
<Counter>\Memory\Pool Paged Resident Bytes</Counter>
<Counter>\Memory\System Cache Resident Bytes</Counter>
<Counter>\Memory\Transition Pages RePurposed/sec</Counter>
<Counter>\Network Inspection System\Average inspection latency (sec/bytes)</Counter>
<Counter>\Network Interface(*)\Bytes Received/sec</Counter>
<Counter>\Network Interface(*)\Bytes Sent/sec</Counter>
<Counter>\Network Interface(*)\Bytes Total/sec</Counter>
<Counter>\Network Interface(*)\Current Bandwidth</Counter>
<Counter>\Network Interface(*)\Output Queue Length</Counter>
<Counter>\Network Interface(*)\Packets Outbound Errors</Counter>
<Counter>\Network Interface(*)\Packets Received/sec</Counter>
<Counter>\Network Interface(*)\Packets Sent/sec</Counter>
<Counter>\Network Interface(*)\Packets/sec</Counter>
<Counter>\Paging File(*)\% Usage</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\PhysicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\Process(*)\% Processor Time</Counter>
<Counter>\Process(*)\Handle Count</Counter>
<Counter>\Process(*)\ID Process</Counter>
<Counter>\Process(*)\IO Data Operations/sec</Counter>
<Counter>\Process(*)\IO Other Operations/sec</Counter>
<Counter>\Process(*)\IO Read Operations/sec</Counter>
<Counter>\Process(*)\IO Write Operations/sec</Counter>
<Counter>\Process(*)\Private Bytes</Counter>
<Counter>\Process(*)\Thread Count</Counter>
<Counter>\Process(*)\Virtual Bytes</Counter>
<Counter>\Process(*)\Working Set</Counter>
<Counter>\Process(sqlservr)\% Privileged Time</Counter>
<Counter>\Processor Information(*)\% DPC Time</Counter>
<Counter>\Processor Information(*)\% Interrupt Time</Counter>
<Counter>\Processor Information(*)\% of Maximum Frequency</Counter>
<Counter>\Processor Information(*)\% Privileged Time</Counter>
<Counter>\Processor Information(*)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% User Time</Counter>
<Counter>\Processor Information(*)\DPC Rate</Counter>
<Counter>\Processor Information(*)\Parking Status</Counter>
<Counter>\Processor(*)\% DPC Time</Counter>
<Counter>\Processor(*)\% Interrupt Time</Counter>
<Counter>\Processor(*)\% Privileged Time</Counter>
<Counter>\Processor(*)\% Processor Time</Counter>
<Counter>\Processor(*)\% User Time</Counter>
<Counter>\Processor(*)\DPC Rate</Counter>
<Counter>\Server\Pool Nonpaged Failures</Counter>
<Counter>\Server\Pool Paged Failures</Counter>
<Counter>\SQLServer:Access Methods\Forwarded Records/sec</Counter>
<Counter>\SQLServer:Access Methods\FreeSpace Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Full Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Index Searches/sec</Counter>
<Counter>\SQLServer:Access Methods\Page Splits/sec</Counter>
<Counter>\SQLServer:Access Methods\Scan Point Revalidations/sec</Counter>
<Counter>\SQLServer:Access Methods\Workfiles Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables Created/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Buffer cache hit ratio</Counter>
<Counter>\SQLServer:Buffer Manager\Checkpoint pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free pages</Counter>
<Counter>\SQLServer:Buffer Manager\Lazy writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Manager\Page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page reads/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page writes/sec</Counter>
<Counter>\SQLServer:General Statistics\Logins/sec</Counter>
<Counter>\SQLServer:General Statistics\Logouts/sec</Counter>
<Counter>\SQLServer:General Statistics\User Connections</Counter>
<Counter>\SQLServer:Latches\Latch Waits/sec</Counter>
<Counter>\SQLServer:Latches\Total Latch Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Requests/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Timeouts/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Waits/sec</Counter>
<Counter>\SQLServer:Locks(*)\Number of Deadlocks/sec</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Pending</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory(KB)</Counter>
<Counter>\SQLServer:Memory Manager\Total Server Memory (KB)</Counter>
<Counter>\SQLServer:SQL Statistics\Batch Requests/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Re-Compilations/sec</Counter>
<Counter>\System\Context Switches/sec</Counter>
<Counter>\System\Processor Queue Length</Counter>
<Counter>\System\System Calls/sec</Counter>
<Counter>\TCPv4\Connection Failures</Counter>
</PerformanceCounterDataCollector>
</DataCollectorSet>
<DataCollectorSet>
<Name>PAL - SQL Server 2008 and R2</Name>
<DisplayName>PAL - SQL Server 2008 and R2</DisplayName>
<DisplayNameUnresolved>PAL - SQL Server 2008 and R2</DisplayNameUnresolved>
<Description>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</Description>
<DescriptionUnresolved>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</DescriptionUnresolved>
<SubdirectoryFormat>3</SubdirectoryFormat>
<SubdirectoryFormatPattern>yyyyMMdd\-NNNNNN</SubdirectoryFormatPattern>
<PerformanceCounterDataCollector>
<Name>PAL - SQL Server 2008 and R2 Collector</Name>
<SampleInterval>15</SampleInterval>
<Counter>\Cache\Dirty Pages</Counter>
<Counter>\Cache\Lazy Write Flushes/sec</Counter>
<Counter>\LogicalDisk(*)\% Free Space</Counter>
<Counter>\LogicalDisk(*)\% Idle Time</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Write</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\LogicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Reads/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Transfers/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Writes/sec</Counter>
<Counter>\LogicalDisk(*)\Free Megabytes</Counter>
<Counter>\Memory\% Committed Bytes In Use</Counter>
<Counter>\Memory\Available MBytes</Counter>
<Counter>\Memory\Commit Limit</Counter>
<Counter>\Memory\Committed Bytes</Counter>
<Counter>\Memory\Free & Zero Page List Bytes</Counter>
<Counter>\Memory\Free System Page Table Entries</Counter>
<Counter>\Memory\Long-Term Average Standby Cache Lifetime (s)</Counter>
<Counter>\Memory\Pages Input/sec</Counter>
<Counter>\Memory\Pages Output/sec</Counter>
<Counter>\Memory\Pages/sec</Counter>
<Counter>\Memory\Pool Nonpaged Bytes</Counter>
<Counter>\Memory\Pool Paged Bytes</Counter>
<Counter>\Memory\Pool Paged Resident Bytes</Counter>
<Counter>\Memory\System Cache Resident Bytes</Counter>
<Counter>\Memory\Transition Pages RePurposed/sec</Counter>
<Counter>\MSRS 2008 R2 Web Service\Cache Misses/Sec</Counter>
<Counter>\MSRS 2008 R2 Web Service\Report Requests</Counter>
<Counter>\MSRS 2008 R2 Web Service\Total Memory Cache Misses</Counter>
<Counter>\MSRS 2008 R2 Web Service\Total Requests</Counter>
<Counter>\Network Inspection System\Average inspection latency (sec/bytes)</Counter>
<Counter>\Network Interface(*)\Bytes Received/sec</Counter>
<Counter>\Network Interface(*)\Bytes Sent/sec</Counter>
<Counter>\Network Interface(*)\Bytes Total/sec</Counter>
<Counter>\Network Interface(*)\Current Bandwidth</Counter>
<Counter>\Network Interface(*)\Output Queue Length</Counter>
<Counter>\Network Interface(*)\Packets Outbound Errors</Counter>
<Counter>\Network Interface(*)\Packets Received/sec</Counter>
<Counter>\Network Interface(*)\Packets Sent/sec</Counter>
<Counter>\Network Interface(*)\Packets/sec</Counter>
<Counter>\Paging File(*)\% Usage</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\PhysicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\Process(*)\Handle Count</Counter>
<Counter>\Process(*)\ID Process</Counter>
<Counter>\Process(*)\IO Data Operations/sec</Counter>
<Counter>\Process(*)\IO Other Operations/sec</Counter>
<Counter>\Process(*)\IO Read Operations/sec</Counter>
<Counter>\Process(*)\IO Write Operations/sec</Counter>
<Counter>\Process(*)\Private Bytes</Counter>
<Counter>\Process(*)\Thread Count</Counter>
<Counter>\Process(*)\Virtual Bytes</Counter>
<Counter>\Process(*)\Working Set</Counter>
<Counter>\Process(sqlservr)\% Privileged Time</Counter>
<Counter>\Process(sqlservr)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% DPC Time</Counter>
<Counter>\Processor Information(*)\% Interrupt Time</Counter>
<Counter>\Processor Information(*)\% of Maximum Frequency</Counter>
<Counter>\Processor Information(*)\% Privileged Time</Counter>
<Counter>\Processor Information(*)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% User Time</Counter>
<Counter>\Processor Information(*)\DPC Rate</Counter>
<Counter>\Processor Information(*)\Parking Status</Counter>
<Counter>\Processor(*)\% DPC Time</Counter>
<Counter>\Processor(*)\% Interrupt Time</Counter>
<Counter>\Processor(*)\% Privileged Time</Counter>
<Counter>\Processor(*)\% Processor Time</Counter>
<Counter>\Processor(*)\% User Time</Counter>
<Counter>\Processor(*)\DPC Rate</Counter>
<Counter>\ReportServer:Service\Errors Total</Counter>
<Counter>\ReportServer:Service\Errors/sec</Counter>
<Counter>\ReportServer:Service\Memory Pressure State</Counter>
<Counter>\ReportServer:Service\Memory Shrink Amount</Counter>
<Counter>\ReportServer:Service\Memory Shrink Notifications/sec</Counter>
<Counter>\Server\Pool Nonpaged Failures</Counter>
<Counter>\Server\Pool Paged Failures</Counter>
<Counter>\SQLAgent:Jobs\Active jobs</Counter>
<Counter>\SQLAgent:Jobs\Failed jobs</Counter>
<Counter>\SQLAgent:Jobs\Job success rate</Counter>
<Counter>\SQLAgent:Jobs\Successful jobs</Counter>
<Counter>\SQLAgent:JobSteps\Active steps</Counter>
<Counter>\SQLAgent:JobSteps\Total step retries</Counter>
<Counter>\SQLServer:Access Methods\Forwarded Records/sec</Counter>
<Counter>\SQLServer:Access Methods\FreeSpace Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Full Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Index Searches/sec</Counter>
<Counter>\SQLServer:Access Methods\Page Splits/sec</Counter>
<Counter>\SQLServer:Access Methods\Scan Point Revalidations/sec</Counter>
<Counter>\SQLServer:Access Methods\Table Lock Escalations/sec</Counter>
<Counter>\SQLServer:Access Methods\Workfiles Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables From Cache Ratio</Counter>
<Counter>\SQLServer:Buffer Manager\Buffer cache hit ratio</Counter>
<Counter>\SQLServer:Buffer Manager\Checkpoint pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free list stalls/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free pages</Counter>
<Counter>\SQLServer:Buffer Manager\Lazy writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Manager\Page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page reads/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Readahead pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Stolen pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Foreign pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Page life expectancy</Counter>
<Counter>\SQLServer:Databases(*)\Data File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Bytes Flushed/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Used Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Wait Time</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Waits/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Flushes/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Growths</Counter>
<Counter>\SQLServer:Databases(*)\Log Shrinks</Counter>
<Counter>\SQLServer:Databases(*)\Log Truncations</Counter>
<Counter>\SQLServer:Databases(*)\Percent Log Used</Counter>
<Counter>\SQLServer:Deprecated Features(*)\Usage</Counter>
<Counter>\SQLServer:General Statistics\Logins/sec</Counter>
<Counter>\SQLServer:General Statistics\Logouts/sec</Counter>
<Counter>\SQLServer:General Statistics\User Connections</Counter>
<Counter>\SQLServer:Latches\Latch Waits/sec</Counter>
<Counter>\SQLServer:Latches\Total Latch Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Average Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Requests/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Timeouts/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Waits/sec</Counter>
<Counter>\SQLServer:Locks(*)\Number of Deadlocks/sec</Counter>
<Counter>\SQLServer:Memory Manager\Granted Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Maximum Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Outstanding</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Pending</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory(KB)</Counter>
<Counter>\SQLServer:Memory Manager\Total Server Memory (KB)</Counter>
<Counter>\SQLServer:Plan Cache(*)\Cache Hit Ratio</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Max memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Target memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Used memory (KB)</Counter>
<Counter>\SQLServer:SQL Errors(*)\Errors/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Auto-Param Attempts/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Batch Requests/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Failed Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Safe Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Attention rate</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Re-Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Unsafe Auto-Params/sec</Counter>
<Counter>\SQLServer:SSIS Pipeline 10.0\Buffer memory</Counter>
<Counter>\SQLServer:SSIS Pipeline 10.0\Buffers in use</Counter>
<Counter>\SQLServer:SSIS Pipeline 10.0\Buffers spooled</Counter>
<Counter>\SQLServer:SSIS Pipeline 10.0\Flat buffers in use</Counter>
<Counter>\SQLServer:SSIS Pipeline 10.0\Private buffers in use</Counter>
<Counter>\SQLServer:Transactions\Free Space in tempdb (KB)</Counter>
<Counter>\SQLServer:Transactions\Longest Transaction Running Time</Counter>
<Counter>\SQLServer:Transactions\NonSnapshot Version Transactions</Counter>
<Counter>\SQLServer:Transactions\Snapshot Transactions</Counter>
<Counter>\SQLServer:Transactions\Version Cleanup rate (KB/s)</Counter>
<Counter>\SQLServer:Transactions\Version Generation rate (KB/s)</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Queued requests</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Requests completed/sec</Counter>
<Counter>\System\Context Switches/sec</Counter>
<Counter>\System\Processor Queue Length</Counter>
<Counter>\System\System Calls/sec</Counter>
<Counter>\TCPv4\Connection Failures</Counter>
</PerformanceCounterDataCollector>
</DataCollectorSet>
<DataCollectorSet>
<Name>PAL - SQL Server 2012</Name>
<DisplayName>PAL - SQL Server 2012</DisplayName>
<DisplayNameUnresolved>PAL - SQL Server 2012</DisplayNameUnresolved>
<Description>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</Description>
<DescriptionUnresolved>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</DescriptionUnresolved>
<SubdirectoryFormat>3</SubdirectoryFormat>
<SubdirectoryFormatPattern>yyyyMMdd\-NNNNNN</SubdirectoryFormatPattern>
<PerformanceCounterDataCollector>
<Name>PAL - SQL Server 2012 Collector</Name>
<SampleInterval>15</SampleInterval>
<Counter>\Cache\Dirty Pages</Counter>
<Counter>\Cache\Lazy Write Flushes/sec</Counter>
<Counter>\LogicalDisk(*)\% Free Space</Counter>
<Counter>\LogicalDisk(*)\% Idle Time</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Write</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\LogicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Reads/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Transfers/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Writes/sec</Counter>
<Counter>\LogicalDisk(*)\Free Megabytes</Counter>
<Counter>\Memory\% Committed Bytes In Use</Counter>
<Counter>\Memory\Available MBytes</Counter>
<Counter>\Memory\Commit Limit</Counter>
<Counter>\Memory\Committed Bytes</Counter>
<Counter>\Memory\Free & Zero Page List Bytes</Counter>
<Counter>\Memory\Free System Page Table Entries</Counter>
<Counter>\Memory\Long-Term Average Standby Cache Lifetime (s)</Counter>
<Counter>\Memory\Pages Input/sec</Counter>
<Counter>\Memory\Pages Output/sec</Counter>
<Counter>\Memory\Pages/sec</Counter>
<Counter>\Memory\Pool Nonpaged Bytes</Counter>
<Counter>\Memory\Pool Paged Bytes</Counter>
<Counter>\Memory\Pool Paged Resident Bytes</Counter>
<Counter>\Memory\System Cache Resident Bytes</Counter>
<Counter>\Memory\Transition Pages RePurposed/sec</Counter>
<Counter>\MSRS 2011 Web Service\Cache Misses/Sec</Counter>
<Counter>\MSRS 2011 Web Service\Report Requests</Counter>
<Counter>\MSRS 2011 Web Service\Total Memory Cache Misses</Counter>
<Counter>\MSRS 2011 Web Service\Total Requests</Counter>
<Counter>\Network Inspection System\Average inspection latency (sec/bytes)</Counter>
<Counter>\Network Interface(*)\Bytes Received/sec</Counter>
<Counter>\Network Interface(*)\Bytes Sent/sec</Counter>
<Counter>\Network Interface(*)\Bytes Total/sec</Counter>
<Counter>\Network Interface(*)\Current Bandwidth</Counter>
<Counter>\Network Interface(*)\Output Queue Length</Counter>
<Counter>\Network Interface(*)\Packets Outbound Errors</Counter>
<Counter>\Network Interface(*)\Packets Received/sec</Counter>
<Counter>\Network Interface(*)\Packets Sent/sec</Counter>
<Counter>\Network Interface(*)\Packets/sec</Counter>
<Counter>\Paging File(*)\% Usage</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\PhysicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\Process(*)\Handle Count</Counter>
<Counter>\Process(*)\ID Process</Counter>
<Counter>\Process(*)\IO Data Operations/sec</Counter>
<Counter>\Process(*)\IO Other Operations/sec</Counter>
<Counter>\Process(*)\IO Read Operations/sec</Counter>
<Counter>\Process(*)\IO Write Operations/sec</Counter>
<Counter>\Process(*)\Private Bytes</Counter>
<Counter>\Process(*)\Thread Count</Counter>
<Counter>\Process(*)\Virtual Bytes</Counter>
<Counter>\Process(*)\Working Set</Counter>
<Counter>\Process(sqlservr)\% Privileged Time</Counter>
<Counter>\Process(sqlservr)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% DPC Time</Counter>
<Counter>\Processor Information(*)\% Interrupt Time</Counter>
<Counter>\Processor Information(*)\% of Maximum Frequency</Counter>
<Counter>\Processor Information(*)\% Privileged Time</Counter>
<Counter>\Processor Information(*)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% User Time</Counter>
<Counter>\Processor Information(*)\DPC Rate</Counter>
<Counter>\Processor Information(*)\Parking Status</Counter>
<Counter>\Processor(*)\% DPC Time</Counter>
<Counter>\Processor(*)\% Interrupt Time</Counter>
<Counter>\Processor(*)\% Privileged Time</Counter>
<Counter>\Processor(*)\% Processor Time</Counter>
<Counter>\Processor(*)\% User Time</Counter>
<Counter>\Processor(*)\DPC Rate</Counter>
<Counter>\ReportServer:Service\Errors Total</Counter>
<Counter>\ReportServer:Service\Errors/sec</Counter>
<Counter>\ReportServer:Service\Memory Pressure State</Counter>
<Counter>\ReportServer:Service\Memory Shrink Amount</Counter>
<Counter>\ReportServer:Service\Memory Shrink Notifications/sec</Counter>
<Counter>\Server\Pool Nonpaged Failures</Counter>
<Counter>\Server\Pool Paged Failures</Counter>
<Counter>\SQLAgent:Jobs\Active jobs</Counter>
<Counter>\SQLAgent:Jobs\Failed jobs</Counter>
<Counter>\SQLAgent:Jobs\Job success rate</Counter>
<Counter>\SQLAgent:Jobs\Successful jobs</Counter>
<Counter>\SQLAgent:JobSteps\Active steps</Counter>
<Counter>\SQLAgent:JobSteps\Total step retries</Counter>
<Counter>\SQLServer:Access Methods\Forwarded Records/sec</Counter>
<Counter>\SQLServer:Access Methods\FreeSpace Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Full Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Index Searches/sec</Counter>
<Counter>\SQLServer:Access Methods\Page Splits/sec</Counter>
<Counter>\SQLServer:Access Methods\Scan Point Revalidations/sec</Counter>
<Counter>\SQLServer:Access Methods\Table Lock Escalations/sec</Counter>
<Counter>\SQLServer:Access Methods\Workfiles Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables From Cache Ratio</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Received from Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Sent to Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Sent to Transport/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Receives from Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Resent Messages/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Sends to Replica/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Background writer pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Buffer cache hit ratio</Counter>
<Counter>\SQLServer:Buffer Manager\Checkpoint pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free list stalls/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free pages</Counter>
<Counter>\SQLServer:Buffer Manager\Lazy writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Manager\Page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page reads/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Readahead pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Target pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Database pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Foreign pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Local node page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Node(*)\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Node(*)\Remote node page lookups/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Log Bytes Received/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Mirrored Write Transactions/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Recovery Queue</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Log remaining for undo</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Log Send Queue</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redo blocked/sec</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redo Bytes Remaining</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redone Bytes/sec</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Total Log requiring undo</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Transaction Delay</Counter>
<Counter>\SQLServer:Databases(*)\Active Transactions</Counter>
<Counter>\SQLServer:Databases(*)\Backup/Restore Throughput/sec</Counter>
<Counter>\SQLServer:Databases(*)\Bulk Copy Throughput/sec</Counter>
<Counter>\SQLServer:Databases(*)\Data File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Bytes Flushed/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Used Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Wait Time</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Waits/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Flushes/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Growths</Counter>
<Counter>\SQLServer:Databases(*)\Log Shrinks</Counter>
<Counter>\SQLServer:Databases(*)\Log Truncations</Counter>
<Counter>\SQLServer:Databases(*)\Percent Log Used</Counter>
<Counter>\SQLServer:Deprecated Features(*)\Usage</Counter>
<Counter>\SQLServer:General Statistics\Active Temp Tables</Counter>
<Counter>\SQLServer:General Statistics\Logins/sec</Counter>
<Counter>\SQLServer:General Statistics\Logouts/sec</Counter>
<Counter>\SQLServer:General Statistics\Temp Tables Creation Rate</Counter>
<Counter>\SQLServer:General Statistics\Temp Tables For Destruction</Counter>
<Counter>\SQLServer:General Statistics\User Connections</Counter>
<Counter>\SQLServer:Latches\Latch Waits/sec</Counter>
<Counter>\SQLServer:Latches\Total Latch Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Average Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Requests/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Timeouts/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Waits/sec</Counter>
<Counter>\SQLServer:Locks(*)\Number of Deadlocks/sec</Counter>
<Counter>\SQLServer:Memory Manager\Granted Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Maximum Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Outstanding</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Pending</Counter>
<Counter>\SQLServer:Memory Manager\Optimizer Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Stolen Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory(KB)</Counter>
<Counter>\SQLServer:Memory Manager\Total Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Database Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Foreign Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Stolen Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Target Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(000)\Total Node Memory (KB)</Counter>
<Counter>\SQLServer:Plan Cache(*)\Cache Hit Ratio</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Max memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Target memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Used memory (KB)</Counter>
<Counter>\SQLServer:SQL Errors(*)\Errors/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Auto-Param Attempts/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Batch Requests/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Failed Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Safe Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Attention rate</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Re-Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Unsafe Auto-Params/sec</Counter>
<Counter>\SQLServer:Transactions\Free Space in tempdb (KB)</Counter>
<Counter>\SQLServer:Transactions\Longest Transaction Running Time</Counter>
<Counter>\SQLServer:Transactions\NonSnapshot Version Transactions</Counter>
<Counter>\SQLServer:Transactions\Snapshot Transactions</Counter>
<Counter>\SQLServer:Transactions\Transactions</Counter>
<Counter>\SQLServer:Transactions\Version Cleanup rate (KB/s)</Counter>
<Counter>\SQLServer:Transactions\Version Generation rate (KB/s)</Counter>
<Counter>\SQLServer:Transactions\Version Store Size (KB)</Counter>
<Counter>\SQLServer:User Settable(*)\Query</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Active parallel threads</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Active requests</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Queued requests</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Reduced memory grants/sec</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Requests completed/sec</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Suboptimal plans/sec</Counter>
<Counter>\System\Context Switches/sec</Counter>
<Counter>\System\Processor Queue Length</Counter>
<Counter>\System\System Calls/sec</Counter>
<Counter>\TCPv4\Connection Failures</Counter>
</PerformanceCounterDataCollector>
</DataCollectorSet>
<DataCollectorSet>
<Name>PAL - SQL Server 2014 and Up</Name>
<DisplayName>PAL - SQL Server 2014 and Up</DisplayName>
<DisplayNameUnresolved>PAL - SQL Server 2014 and Up</DisplayNameUnresolved>
<Description>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</Description>
<DescriptionUnresolved>Data Collector Sets from PAL, a performance monitor data aggregation tool by Microsoft. The toolset was created by Microsoft PFE Clint Huffman who worked with fellow experts to create a list specialized lists of counters. You can find the project at github.com/clinthuffman/PAL</DescriptionUnresolved>
<SubdirectoryFormat>3</SubdirectoryFormat>
<SubdirectoryFormatPattern>yyyyMMdd\-NNNNNN</SubdirectoryFormatPattern>
<PerformanceCounterDataCollector>
<Name>PAL - SQL Server 2014 and Up Collector</Name>
<SampleInterval>15</SampleInterval>
<Counter>\Cache\Dirty Pages</Counter>
<Counter>\Cache\Lazy Write Flushes/sec</Counter>
<Counter>\LogicalDisk(*)\% Free Space</Counter>
<Counter>\LogicalDisk(*)\% Idle Time</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Bytes/Write</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Transfer</Counter>
<Counter>\LogicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\LogicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\LogicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Reads/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Transfers/sec</Counter>
<Counter>\LogicalDisk(*)\Disk Writes/sec</Counter>
<Counter>\LogicalDisk(*)\Free Megabytes</Counter>
<Counter>\Memory\% Committed Bytes In Use</Counter>
<Counter>\Memory\Available MBytes</Counter>
<Counter>\Memory\Commit Limit</Counter>
<Counter>\Memory\Committed Bytes</Counter>
<Counter>\Memory\Free & Zero Page List Bytes</Counter>
<Counter>\Memory\Free System Page Table Entries</Counter>
<Counter>\Memory\Long-Term Average Standby Cache Lifetime (s)</Counter>
<Counter>\Memory\Pages Input/sec</Counter>
<Counter>\Memory\Pages Output/sec</Counter>
<Counter>\Memory\Pages/sec</Counter>
<Counter>\Memory\Pool Nonpaged Bytes</Counter>
<Counter>\Memory\Pool Paged Bytes</Counter>
<Counter>\Memory\Pool Paged Resident Bytes</Counter>
<Counter>\Memory\System Cache Resident Bytes</Counter>
<Counter>\Memory\Transition Pages RePurposed/sec</Counter>
<Counter>\MSRS 2011 Web Service\Cache Misses/Sec</Counter>
<Counter>\MSRS 2011 Web Service\Report Requests</Counter>
<Counter>\MSRS 2011 Web Service\Total Memory Cache Misses</Counter>
<Counter>\MSRS 2011 Web Service\Total Requests</Counter>
<Counter>\Network Inspection System\Average inspection latency (sec/bytes)</Counter>
<Counter>\Network Interface(*)\Bytes Received/sec</Counter>
<Counter>\Network Interface(*)\Bytes Sent/sec</Counter>
<Counter>\Network Interface(*)\Bytes Total/sec</Counter>
<Counter>\Network Interface(*)\Current Bandwidth</Counter>
<Counter>\Network Interface(*)\Output Queue Length</Counter>
<Counter>\Network Interface(*)\Packets Outbound Errors</Counter>
<Counter>\Network Interface(*)\Packets Received/sec</Counter>
<Counter>\Network Interface(*)\Packets Sent/sec</Counter>
<Counter>\Network Interface(*)\Packets/sec</Counter>
<Counter>\Paging File(*)\% Usage</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Read</Counter>
<Counter>\PhysicalDisk(*)\Avg. Disk sec/Write</Counter>
<Counter>\PhysicalDisk(*)\Current Disk Queue Length</Counter>
<Counter>\PhysicalDisk(*)\Disk Bytes/sec</Counter>
<Counter>\Process(*)\Handle Count</Counter>
<Counter>\Process(*)\ID Process</Counter>
<Counter>\Process(*)\IO Data Operations/sec</Counter>
<Counter>\Process(*)\IO Other Operations/sec</Counter>
<Counter>\Process(*)\IO Read Operations/sec</Counter>
<Counter>\Process(*)\IO Write Operations/sec</Counter>
<Counter>\Process(*)\Private Bytes</Counter>
<Counter>\Process(*)\Thread Count</Counter>
<Counter>\Process(*)\Virtual Bytes</Counter>
<Counter>\Process(*)\Working Set</Counter>
<Counter>\Process(sqlservr)\% Privileged Time</Counter>
<Counter>\Process(sqlservr)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% DPC Time</Counter>
<Counter>\Processor Information(*)\% Interrupt Time</Counter>
<Counter>\Processor Information(*)\% of Maximum Frequency</Counter>
<Counter>\Processor Information(*)\% Privileged Time</Counter>
<Counter>\Processor Information(*)\% Processor Time</Counter>
<Counter>\Processor Information(*)\% User Time</Counter>
<Counter>\Processor Information(*)\DPC Rate</Counter>
<Counter>\Processor Information(*)\Parking Status</Counter>
<Counter>\Processor(*)\% DPC Time</Counter>
<Counter>\Processor(*)\% Interrupt Time</Counter>
<Counter>\Processor(*)\% Privileged Time</Counter>
<Counter>\Processor(*)\% Processor Time</Counter>
<Counter>\Processor(*)\% User Time</Counter>
<Counter>\Processor(*)\DPC Rate</Counter>
<Counter>\ReportServer:Service\Errors Total</Counter>
<Counter>\ReportServer:Service\Errors/sec</Counter>
<Counter>\ReportServer:Service\Memory Pressure State</Counter>
<Counter>\ReportServer:Service\Memory Shrink Amount</Counter>
<Counter>\ReportServer:Service\Memory Shrink Notifications/sec</Counter>
<Counter>\Server\Pool Nonpaged Failures</Counter>
<Counter>\Server\Pool Paged Failures</Counter>
<Counter>\SQLAgent:Jobs\Active jobs</Counter>
<Counter>\SQLAgent:Jobs\Failed jobs</Counter>
<Counter>\SQLAgent:Jobs\Job success rate</Counter>
<Counter>\SQLAgent:Jobs\Successful jobs</Counter>
<Counter>\SQLAgent:JobSteps\Active steps</Counter>
<Counter>\SQLAgent:JobSteps\Total step retries</Counter>
<Counter>\SQLServer:Access Methods\Forwarded Records/sec</Counter>
<Counter>\SQLServer:Access Methods\FreeSpace Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Full Scans/sec</Counter>
<Counter>\SQLServer:Access Methods\Index Searches/sec</Counter>
<Counter>\SQLServer:Access Methods\Page Splits/sec</Counter>
<Counter>\SQLServer:Access Methods\Scan Point Revalidations/sec</Counter>
<Counter>\SQLServer:Access Methods\Table Lock Escalations/sec</Counter>
<Counter>\SQLServer:Access Methods\Workfiles Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables Created/sec</Counter>
<Counter>\SQLServer:Access Methods\Worktables From Cache Ratio</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Received from Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Sent to Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(*)\Bytes Sent to Transport/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Receives from Replica/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Resent Messages/sec</Counter>
<Counter>\SQLServer:Availability Replica(_Total)\Sends to Replica/sec</Counter>
<Counter>\SQLServer:Buffer Manager(*)\Extension page unreferenced time</Counter>
<Counter>\SQLServer:Buffer Manager\Background writer pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Buffer cache hit ratio</Counter>
<Counter>\SQLServer:Buffer Manager\Checkpoint pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Extension free pages</Counter>
<Counter>\SQLServer:Buffer Manager\Extension outstanding IO counter</Counter>
<Counter>\SQLServer:Buffer Manager\Free list stalls/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Free pages</Counter>
<Counter>\SQLServer:Buffer Manager\Lazy writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Manager\Page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page reads/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Page writes/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Readahead pages/sec</Counter>
<Counter>\SQLServer:Buffer Manager\Target pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Database pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Foreign pages</Counter>
<Counter>\SQLServer:Buffer Node(*)\Local node page lookups/sec</Counter>
<Counter>\SQLServer:Buffer Node(*)\Page life expectancy</Counter>
<Counter>\SQLServer:Buffer Node(*)\Remote node page lookups/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Log Bytes Received/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Mirrored Write Transactions/sec</Counter>
<Counter>\SQLServer:Database Replica(*)\Recovery Queue</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Log remaining for undo</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Log Send Queue</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redo blocked/sec</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redo Bytes Remaining</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Redone Bytes/sec</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Total Log requiring undo</Counter>
<Counter>\SQLServer:Database Replica(_Total)\Transaction Delay</Counter>
<Counter>\SQLServer:Databases(*)\Active Transactions</Counter>
<Counter>\SQLServer:Databases(*)\Backup/Restore Throughput/sec</Counter>
<Counter>\SQLServer:Databases(*)\Bulk Copy Throughput/sec</Counter>
<Counter>\SQLServer:Databases(*)\Data File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Bytes Flushed/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log File(s) Used Size (KB)</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Wait Time</Counter>
<Counter>\SQLServer:Databases(*)\Log Flush Waits/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Flushes/sec</Counter>
<Counter>\SQLServer:Databases(*)\Log Growths</Counter>
<Counter>\SQLServer:Databases(*)\Log Shrinks</Counter>
<Counter>\SQLServer:Databases(*)\Log Truncations</Counter>
<Counter>\SQLServer:Databases(*)\Percent Log Used</Counter>
<Counter>\SQLServer:Deprecated Features(*)\Usage</Counter>
<Counter>\SQLServer:General Statistics\Active Temp Tables</Counter>
<Counter>\SQLServer:General Statistics\Logins/sec</Counter>
<Counter>\SQLServer:General Statistics\Logouts/sec</Counter>
<Counter>\SQLServer:General Statistics\Temp Tables Creation Rate</Counter>
<Counter>\SQLServer:General Statistics\Temp Tables For Destruction</Counter>
<Counter>\SQLServer:General Statistics\User Connections</Counter>
<Counter>\SQLServer:Latches\Latch Waits/sec</Counter>
<Counter>\SQLServer:Latches\Total Latch Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Average Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Requests/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Timeouts/sec</Counter>
<Counter>\SQLServer:Locks(*)\Lock Wait Time (ms)</Counter>
<Counter>\SQLServer:Locks(*)\Lock Waits/sec</Counter>
<Counter>\SQLServer:Locks(*)\Number of Deadlocks/sec</Counter>
<Counter>\SQLServer:Memory Manager\Granted Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Maximum Workspace Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Outstanding</Counter>
<Counter>\SQLServer:Memory Manager\Memory Grants Pending</Counter>
<Counter>\SQLServer:Memory Manager\Optimizer Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Stolen Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Manager\Target Server Memory(KB)</Counter>
<Counter>\SQLServer:Memory Manager\Total Server Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Database Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Foreign Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Stolen Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(*)\Target Node Memory (KB)</Counter>
<Counter>\SQLServer:Memory Node(000)\Total Node Memory (KB)</Counter>
<Counter>\SQLServer:Plan Cache(*)\Cache Hit Ratio</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Max memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Target memory (KB)</Counter>
<Counter>\SQLServer:Resource Pool Stats(*)\Used memory (KB)</Counter>
<Counter>\SQLServer:SQL Errors(*)\Errors/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Auto-Param Attempts/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Batch Requests/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Failed Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Safe Auto-Params/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Attention rate</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\SQL Re-Compilations/sec</Counter>
<Counter>\SQLServer:SQL Statistics\Unsafe Auto-Params/sec</Counter>
<Counter>\SQLServer:Transactions\Free Space in tempdb (KB)</Counter>
<Counter>\SQLServer:Transactions\Longest Transaction Running Time</Counter>
<Counter>\SQLServer:Transactions\NonSnapshot Version Transactions</Counter>
<Counter>\SQLServer:Transactions\Snapshot Transactions</Counter>
<Counter>\SQLServer:Transactions\Transactions</Counter>
<Counter>\SQLServer:Transactions\Version Cleanup rate (KB/s)</Counter>
<Counter>\SQLServer:Transactions\Version Generation rate (KB/s)</Counter>
<Counter>\SQLServer:Transactions\Version Store Size (KB)</Counter>
<Counter>\SQLServer:User Settable(*)\Query</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Active parallel threads</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Active requests</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\CPU usage %</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Queued requests</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Reduced memory grants/sec</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Requests completed/sec</Counter>
<Counter>\SQLServer:Workload Group Stats(*)\Suboptimal plans/sec</Counter>
<Counter>\System\Context Switches/sec</Counter>
<Counter>\System\Processor Queue Length</Counter>
<Counter>\System\System Calls/sec</Counter>
<Counter>\TCPv4\Connection Failures</Counter>
</PerformanceCounterDataCollector>
</DataCollectorSet>
-- Azure SQL Database Diagnostic Information Queries
-- Glenn Berry
-- Last Modified: JSeptember 11, 2018
-- https://www.sqlskills.com/blogs/glenn/
-- http://sqlserverperformance.wordpress.com/
-- Twitter: GlennAlanBerry
-- Please listen to my Pluralsight courses
-- https://www.pluralsight.com/author/glenn-berry
-- If you want to find all of our SQLskills SQL101 blog posts, check out https://www.sqlskills.com/help/sql101/
--******************************************************************************
--* Copyright (C) 2018 Glenn Berry, SQLskills.com
--* All rights reserved.
--*
--* For more scripts and sample code, check out
--* https://www.sqlskills.com/blogs/glenn
--*
--* You may alter this code for your own *non-commercial* purposes. You may
--* republish altered code as long as you include this copyright and give due credit.
--*
--*
--* THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF
--* ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED
--* TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
--* PARTICULAR PURPOSE.
--*
--******************************************************************************
-- Make sure you are connected a user database, rather than the master system database
-- Server level queries *******************************
-- SQL and OS Version information for current instance (Query 1) (Version Info)
SELECT @@SERVERNAME AS [Server Name], @@VERSION AS [SQL Server and OS Version Info];
------
-- Azure SQL Database does not expose as much information as on-premise SQL Server does
-- Get instance-level configuration values for instance (Query 2) (Configuration Values)
SELECT name, value, value_in_use, minimum, maximum, [description], is_dynamic, is_advanced
FROM sys.configurations WITH (NOLOCK)
ORDER BY name OPTION (RECOMPILE);
------
-- All of these settings are read-only in Azure SQL Database, so they are informational only
-- SQL Server NUMA Node information (Query 3) (SQL Server NUMA Info)
SELECT node_id, node_state_desc, memory_node_id, processor_group, cpu_count, online_scheduler_count,
idle_scheduler_count, active_worker_count, avg_load_balance, resource_monitor_state
FROM sys.dm_os_nodes WITH (NOLOCK)
WHERE node_state_desc <> N'ONLINE DAC' OPTION (RECOMPILE);
------
-- Gives you some useful information about the composition and relative load on your NUMA nodes
-- You want to see an equal number of schedulers on each NUMA node
-- Calculates average stalls per read, per write, and per total input/output for each database file (Query 4) (IO Stalls by File)
SELECT DB_NAME(fs.database_id) AS [Database Name], CAST(fs.io_stall_read_ms/(1.0 + fs.num_of_reads) AS NUMERIC(10,1)) AS [avg_read_stall_ms],
CAST(fs.io_stall_write_ms/(1.0 + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_write_stall_ms],
CAST((fs.io_stall_read_ms + fs.io_stall_write_ms)/(1.0 + fs.num_of_reads + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_io_stall_ms],
fs.io_stall_read_ms, fs.num_of_reads,
fs.io_stall_write_ms, fs.num_of_writes, fs.io_stall_read_ms + fs.io_stall_write_ms AS [io_stalls], fs.num_of_reads + fs.num_of_writes AS [total_io],
io_stall_queued_read_ms AS [Resource Governor Total Read IO Latency (ms)], io_stall_queued_write_ms AS [Resource Governor Total Write IO Latency (ms)]
FROM sys.dm_io_virtual_file_stats(null,null) AS fs
ORDER BY avg_io_stall_ms DESC OPTION (RECOMPILE);
------
-- Helps determine which database files on the entire instance have the most I/O bottlenecks
-- This can help you decide whether certain LUNs are overloaded and whether you might
-- want to move some files to a different location or perhaps improve your I/O performance
-- These latency numbers include all file activity against each SQL Server
-- database file since SQL Server was last started
-- Get I/O utilization by database (Query 5) (IO Usage By Database)
WITH Aggregate_IO_Statistics
AS
(SELECT DB_NAME(database_id) AS [Database Name],
CAST(SUM(num_of_bytes_read + num_of_bytes_written)/1048576 AS DECIMAL(12, 2)) AS io_in_mb
FROM sys.dm_io_virtual_file_stats(NULL, NULL) AS [DM_IO_STATS]
WHERE database_id NOT IN (4, 5, 32767)
GROUP BY database_id)
SELECT ROW_NUMBER() OVER(ORDER BY io_in_mb DESC) AS [I/O Rank], [Database Name],
CAST(io_in_mb/ SUM(io_in_mb) OVER() * 100.0 AS DECIMAL(5,2)) AS [I/O Percent],
io_in_mb AS [Total I/O (MB)]
FROM Aggregate_IO_Statistics
ORDER BY [I/O Rank] OPTION (RECOMPILE);
------
-- Helps determine which database is using the most I/O resources on the instance
-- Get total buffer usage by database for current instance (Query 6) (Total Buffer Usage by Database)
-- This make take some time to run on a busy instance
WITH AggregateBufferPoolUsage
AS
(SELECT DB_NAME(database_id) AS [Database Name], COUNT(page_id) AS [Page Count],
CAST(COUNT(*) * 8/1024.0 AS DECIMAL (10,2)) AS [CachedSize],
AVG(read_microsec) AS [Avg Read Time (microseconds)]
FROM sys.dm_os_buffer_descriptors WITH (NOLOCK)
WHERE database_id NOT IN (4, 5, 32767)
GROUP BY DB_NAME(database_id))
SELECT ROW_NUMBER() OVER(ORDER BY CachedSize DESC) AS [Buffer Pool Rank], [Database Name],
CAST(CachedSize / SUM(CachedSize) OVER() * 100.0 AS DECIMAL(5,2)) AS [Buffer Pool Percent],
[Page Count], CachedSize AS [Cached Size (MB)], [Avg Read Time (microseconds)]
FROM AggregateBufferPoolUsage
ORDER BY [Buffer Pool Rank] OPTION (RECOMPILE);
------
-- Tells you how much memory (in the buffer pool)
-- is being used by each database on the instance
-- Get a count of SQL connections by IP address (Query 7) (Connection Counts by IP Address)
SELECT ec.client_net_address, es.[program_name], es.[host_name], es.login_name,
COUNT(ec.session_id) AS [connection count]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
INNER JOIN sys.dm_exec_connections AS ec WITH (NOLOCK)
ON es.session_id = ec.session_id
GROUP BY ec.client_net_address, es.[program_name], es.[host_name], es.login_name
ORDER BY ec.client_net_address, es.[program_name] OPTION (RECOMPILE);
------
-- This helps you figure where your database load is coming from
-- and verifies connectivity from other machines
-- Solving Connectivity errors to SQL Server
-- https://bit.ly/2EgzoD0
-- Get Average Task Counts (run multiple times) (Query 8) (Avg Task Counts)
SELECT AVG(current_tasks_count) AS [Avg Task Count],
AVG(work_queue_count) AS [Avg Work Queue Count],
AVG(runnable_tasks_count) AS [Avg Runnable Task Count],
AVG(pending_disk_io_count) AS [Avg Pending DiskIO Count]
FROM sys.dm_os_schedulers WITH (NOLOCK)
WHERE scheduler_id < 255 OPTION (RECOMPILE);
------
-- Sustained values above 10 suggest further investigation in that area (depending on your Service Tier)
-- Avg Task Counts will be higher with lower service tiers
-- High Avg Task Counts are often caused by blocking/deadlocking or other resource contention
-- Sustained values above 1 suggest further investigation in that area
-- High Avg Runnable Task Counts are a good sign of CPU pressure
-- High Avg Pending DiskIO Counts are a sign of disk pressure
-- Detect blocking (run multiple times) (Query 9) (Detect Blocking)
SELECT t1.resource_type AS [lock type], DB_NAME(resource_database_id) AS [database],
t1.resource_associated_entity_id AS [blk object],t1.request_mode AS [lock req], -- lock requested
t1.request_session_id AS [waiter sid], t2.wait_duration_ms AS [wait time], -- spid of waiter
(SELECT [text] FROM sys.dm_exec_requests AS r WITH (NOLOCK) -- get sql for waiter
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle])
WHERE r.session_id = t1.request_session_id) AS [waiter_batch],
(SELECT SUBSTRING(qt.[text],r.statement_start_offset/2,
(CASE WHEN r.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE r.statement_end_offset END - r.statement_start_offset)/2)
FROM sys.dm_exec_requests AS r WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle]) AS qt
WHERE r.session_id = t1.request_session_id) AS [waiter_stmt], -- statement blocked
t2.blocking_session_id AS [blocker sid], -- spid of blocker
(SELECT [text] FROM sys.sysprocesses AS p -- get sql for blocker
CROSS APPLY sys.dm_exec_sql_text(p.[sql_handle])
WHERE p.spid = t2.blocking_session_id) AS [blocker_batch]
FROM sys.dm_tran_locks AS t1 WITH (NOLOCK)
INNER JOIN sys.dm_os_waiting_tasks AS t2 WITH (NOLOCK)
ON t1.lock_owner_address = t2.resource_address OPTION (RECOMPILE);
------
-- Helps troubleshoot blocking and deadlocking issues
-- The results will change from second to second on a busy system
-- You should run this query multiple times when you see signs of blocking
-- Page Life Expectancy (PLE) value for each NUMA node in current instance (Query 10) (PLE by NUMA Node)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], instance_name, cntr_value AS [Page Life Expectancy]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Buffer Node%' -- Handles named instances
AND counter_name = N'Page life expectancy' OPTION (RECOMPILE);
------
-- PLE is a good measurement of internal memory pressure
-- Higher PLE is better. Watch the trend over time, not the absolute value
-- This will only return one row for non-NUMA systems
-- Page Life Expectancy isn�t what you think�
-- https://bit.ly/2EgynLa
-- Memory Grants Pending value for current instance (Query 11) (Memory Grants Pending)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], cntr_value AS [Memory Grants Pending]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Memory Manager%' -- Handles named instances
AND counter_name = N'Memory Grants Pending' OPTION (RECOMPILE);
------
-- Run multiple times, and run periodically if you suspect you are under memory pressure
-- Memory Grants Pending above zero for a sustained period is a very strong indicator of internal memory pressure
-- Memory Clerk Usage for instance (Query 12) (Memory Clerk Usage)
-- Look for high value for CACHESTORE_SQLCP (Ad-hoc query plans)
SELECT TOP(10) mc.[type] AS [Memory Clerk Type],
CAST((SUM(mc.pages_kb)/1024.0) AS DECIMAL (15,2)) AS [Memory Usage (MB)]
FROM sys.dm_os_memory_clerks AS mc WITH (NOLOCK)
GROUP BY mc.[type]
ORDER BY SUM(mc.pages_kb) DESC OPTION (RECOMPILE);
------
-- MEMORYCLERK_SQLBUFFERPOOL was new for SQL Server 2012. It should be your highest consumer of memory
-- CACHESTORE_SQLCP SQL Plans
-- These are cached SQL statements or batches that aren't in stored procedures, functions and triggers
-- Watch out for high values for CACHESTORE_SQLCP
-- Enabling 'optimize for ad hoc workloads' at the instance level can help reduce this
-- CACHESTORE_OBJCP Object Plans
-- These are compiled plans for stored procedures, functions and triggers
-- Find single-use, ad-hoc and prepared queries that are bloating the plan cache (Query 13) (Ad hoc Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name], t.[text] AS [Query Text],
cp.objtype AS [Object Type], cp.cacheobjtype AS [Cache Object Type],
cp.size_in_bytes/1024 AS [Plan Size in KB]
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
WHERE cp.cacheobjtype = N'Compiled Plan'
AND cp.objtype IN (N'Adhoc', N'Prepared')
AND cp.usecounts = 1
ORDER BY cp.size_in_bytes DESC, DB_NAME(t.[dbid]) OPTION (RECOMPILE);
------
-- Gives you the text, type and size of single-use ad-hoc and prepared queries that waste space in the plan cache
-- Enabling forced parameterization for the database can help, but test first!
-- Plan cache, adhoc workloads and clearing the single-use plan cache bloat
-- https://bit.ly/2EfYOkl
-- Database specific queries *****************************************************************
-- Azure SQL Database size (Query 14) (Azure SQL DB Size)
SELECT CAST(SUM(CAST(FILEPROPERTY(name, 'SpaceUsed') AS bigint) * 8192.) / 1024 / 1024 AS DECIMAL(15,2)) AS [Database Size In MB],
CAST(SUM(CAST(FILEPROPERTY(name, 'SpaceUsed') AS bigint) * 8192.) / 1024 / 1024 / 1024 AS DECIMAL(15,2)) AS [Database Size In GB]
FROM sys.database_files WITH (NOLOCK)
WHERE [type_desc] = N'ROWS' OPTION (RECOMPILE);
------
-- This gives you the actual space usage within the data file only, to match what the Azure portal shows for the database size
-- Determining Database Size in Azure SQL Database V12
-- https://bit.ly/2JjrqNh
-- Individual File Sizes and space available for current database (Query 15) (File Sizes and Space)
SELECT f.name AS [File Name] , f.physical_name AS [Physical Name],
CAST((f.size/128.0) AS DECIMAL(15,2)) AS [Total Size in MB],
CAST(f.size/128.0 - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS DECIMAL(15,2))
AS [Available Space In MB], f.[file_id], fg.name AS [Filegroup Name],
f.is_percent_growth, f.growth, fg.is_default, fg.is_read_only,
fg.is_autogrow_all_files
FROM sys.database_files AS f WITH (NOLOCK)
LEFT OUTER JOIN sys.filegroups AS fg WITH (NOLOCK)
ON f.data_space_id = fg.data_space_id
ORDER BY f.[file_id] OPTION (RECOMPILE);
------
-- Look at how large and how full the files are and where they are located
-- is_autogrow_all_files was new for SQL Server 2016. Equivalent to TF 1117 for user databases
-- SQL Server 2016: Changes in default behavior for autogrow and allocations for tempdb and user databases
-- http://bit.ly/2evRZSR
-- Log space usage for current database (Query 16) (Log Space Usage)
SELECT DB_NAME(lsu.database_id) AS [Database Name], db.recovery_model_desc AS [Recovery Model],
CAST(lsu.total_log_size_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Total Log Space (MB)],
CAST(lsu.used_log_space_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space (MB)],
CAST(lsu.used_log_space_in_percent AS DECIMAL(10, 2)) AS [Used Log Space %],
CAST(lsu.log_space_in_bytes_since_last_backup/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space Since Last Backup (MB)],
db.log_reuse_wait_desc
FROM sys.dm_db_log_space_usage AS lsu WITH (NOLOCK)
INNER JOIN sys.databases AS db WITH (NOLOCK)
ON lsu.database_id = db.database_id
OPTION (RECOMPILE);
------
-- Look at log file size and usage, along with the log reuse wait description for the current database
-- Get VLF Counts for current database (Query 17) (VLF Counts)
SELECT�[name] AS [Database Name],�[VLF Count]
FROM�sys.databases�AS db WITH (NOLOCK)
CROSS APPLY�(SELECT�file_id, COUNT(*)�AS [VLF Count]�
FROM sys.dm_db_log_info(db.database_id)
���������� GROUP BY�file_id)�AS li
WHERE [name] <> N'master'
ORDER BY [VLF Count] DESC OPTION (RECOMPILE);
------
-- High VLF counts can affect write performance to the log file
-- and they can make full database restores and crash recovery take much longer
-- Try to keep your VLF counts under 200 in most cases (depending on log file size)
-- Important change to VLF creation algorithm in SQL Server 2014
-- https://bit.ly/2Hsjbg4
-- Status of last VLF for current database (Query 18) (Last VLF Status)
SELECT TOP(1) DB_NAME(li.database_id) AS [Database Name], li.[file_id],
li.vlf_size_mb, li.vlf_sequence_number, li.vlf_active, li.vlf_status
FROM sys.dm_db_log_info(DB_ID()) AS li
ORDER BY vlf_sequence_number DESC OPTION (RECOMPILE);
------
-- Determine whether you will be able to shrink the transaction log file
-- vlf_status Values
-- 0 is inactive
-- 1 is initialized but unused
-- 2 is active
-- Important database properties for current database (Query 19) (Database Properties)
SELECT db.[name] AS [Database Name], db.recovery_model_desc AS [Recovery Model],
db.state_desc, db.containment_desc, db.log_reuse_wait_desc AS [Log Reuse Wait Description],
db.[compatibility_level] AS [DB Compatibility Level],
db.is_mixed_page_allocation_on, db.page_verify_option_desc AS [Page Verify Option],
db.is_auto_create_stats_on, db.is_auto_update_stats_on, db.is_auto_update_stats_async_on, db.is_parameterization_forced,
db.snapshot_isolation_state_desc, db.is_read_committed_snapshot_on, db.is_auto_close_on, db.is_auto_shrink_on,
db.target_recovery_time_in_seconds, db.is_cdc_enabled, db.is_memory_optimized_elevate_to_snapshot_on,
db.delayed_durability_desc, db.is_auto_create_stats_incremental_on,
db.is_query_store_on, db.is_sync_with_backup, db.is_temporal_history_retention_enabled,
db.is_encrypted
FROM sys.databases AS db WITH (NOLOCK)
WHERE db.[name] <> N'master'
ORDER BY db.[name] OPTION (RECOMPILE);
------
-- Things to look at:
-- What recovery models are you using?
-- What is the log reuse wait description?
-- What compatibility level are the databases on?
-- What is the Page Verify Option? (should be CHECKSUM)
-- Is Auto Update Statistics Asynchronously enabled?
-- Is Delayed Durability enabled?
-- Make sure auto_shrink and auto_close are not enabled!
-- Get database scoped configuration values for current database (Query 20) (Database-scoped Configurations)
SELECT configuration_id, [name], [value] AS [value_for_primary]
FROM sys.database_scoped_configurations WITH (NOLOCK) OPTION (RECOMPILE);
------
-- This lets you see the value of these new properties for the current database
-- Clear plan cache for current database
-- ALTER DATABASE SCOPED CONFIGURATION CLEAR PROCEDURE_CACHE;
-- ALTER DATABASE SCOPED CONFIGURATION (Transact-SQL)
-- https://bit.ly/2sOH7nb
-- I/O Statistics by file for the current database (Query 21) (IO Stats By File)
SELECT DB_NAME(DB_ID()) AS [Database Name], df.name AS [Logical Name], vfs.[file_id], df.type_desc,
df.physical_name AS [Physical Name], CAST(vfs.size_on_disk_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Size on Disk (MB)],
vfs.num_of_reads, vfs.num_of_writes, vfs.io_stall_read_ms, vfs.io_stall_write_ms,
CAST(100. * vfs.io_stall_read_ms/(vfs.io_stall_read_ms + vfs.io_stall_write_ms) AS DECIMAL(10,1)) AS [IO Stall Reads Pct],
CAST(100. * vfs.io_stall_write_ms/(vfs.io_stall_write_ms + vfs.io_stall_read_ms) AS DECIMAL(10,1)) AS [IO Stall Writes Pct],
(vfs.num_of_reads + vfs.num_of_writes) AS [Writes + Reads],
CAST(vfs.num_of_bytes_read/1048576.0 AS DECIMAL(10, 2)) AS [MB Read],
CAST(vfs.num_of_bytes_written/1048576.0 AS DECIMAL(10, 2)) AS [MB Written],
CAST(100. * vfs.num_of_reads/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Reads Pct],
CAST(100. * vfs.num_of_writes/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Write Pct],
CAST(100. * vfs.num_of_bytes_read/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Read Bytes Pct],
CAST(100. * vfs.num_of_bytes_written/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Written Bytes Pct]
FROM sys.dm_io_virtual_file_stats(DB_ID(), NULL) AS vfs
INNER JOIN sys.database_files AS df WITH (NOLOCK)
ON vfs.[file_id]= df.[file_id] OPTION (RECOMPILE);
------
-- This helps you characterize your workload better from an I/O perspective for this database
-- It helps you determine whether you has an OLTP or DW/DSS type of workload
-- Get recent resource usage (Query 22) (Recent Resource Usage)
SELECT dtu_limit, cpu_limit, avg_cpu_percent, avg_data_io_percent, avg_log_write_percent, avg_memory_usage_percent, xtp_storage_percent,
max_worker_percent, max_session_percent, avg_login_rate_percent, end_time
FROM sys.dm_db_resource_stats WITH (NOLOCK)
ORDER BY end_time DESC OPTION (RECOMPILE);
------
-- Returns a row of usage metrics every 15 seconds, going back 64 minutes
-- The end_time column is UTC time
-- sys.dm_db_resource_stats (Azure SQL Database)
-- https://bit.ly/2HaSpKn
-- Get recent resource usage (Query 23) (Avg/Max Resource Usage)
SELECT AVG(avg_cpu_percent) AS [Average CPU Utilization In Percent],
MAX(avg_cpu_percent) AS [Maximum CPU Utilization In Percent],
AVG(avg_data_io_percent) AS [Average Data IO In Percent],
MAX(avg_data_io_percent) AS [Maximum Data IO In Percent],
AVG(avg_log_write_percent) AS [Average Log Write Utilization In Percent],
MAX(avg_log_write_percent) AS [Maximum Log Write Utilization In Percent],
AVG(avg_memory_usage_percent) AS [Average Memory Usage In Percent],
MAX(avg_memory_usage_percent) AS [Maximum Memory Usage In Percent]
FROM sys.dm_db_resource_stats WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Isolate top waits for this database since last restart or failover (Query 24) (Top DB Waits)
WITH [Waits]
AS (SELECT wait_type, wait_time_ms/ 1000.0 AS [WaitS],
(wait_time_ms - signal_wait_time_ms) / 1000.0 AS [ResourceS],
signal_wait_time_ms / 1000.0 AS [SignalS],
waiting_tasks_count AS [WaitCount],
100.0 * wait_time_ms / SUM (wait_time_ms) OVER() AS [Percentage],
ROW_NUMBER() OVER(ORDER BY wait_time_ms DESC) AS [RowNum]
FROM sys.dm_db_wait_stats WITH (NOLOCK)
WHERE [wait_type] NOT IN (
N'BROKER_EVENTHANDLER', N'BROKER_RECEIVE_WAITFOR', N'BROKER_TASK_STOP',
N'BROKER_TO_FLUSH', N'BROKER_TRANSMITTER', N'CHECKPOINT_QUEUE',
N'CHKPT', N'CLR_AUTO_EVENT', N'CLR_MANUAL_EVENT', N'CLR_SEMAPHORE',
N'DBMIRROR_DBM_EVENT', N'DBMIRROR_EVENTS_QUEUE', N'DBMIRROR_WORKER_QUEUE',
N'DBMIRRORING_CMD', N'DIRTY_PAGE_POLL', N'DISPATCHER_QUEUE_SEMAPHORE',
N'EXECSYNC', N'FSAGENT', N'FT_IFTS_SCHEDULER_IDLE_WAIT', N'FT_IFTSHC_MUTEX',
N'HADR_CLUSAPI_CALL', N'HADR_FILESTREAM_IOMGR_IOCOMPLETION', N'HADR_LOGCAPTURE_WAIT',
N'HADR_NOTIFICATION_DEQUEUE', N'HADR_TIMER_TASK', N'HADR_WORK_QUEUE',
N'KSOURCE_WAKEUP', N'LAZYWRITER_SLEEP', N'LOGMGR_QUEUE',
N'MEMORY_ALLOCATION_EXT', N'ONDEMAND_TASK_QUEUE',
N'PREEMPTIVE_HADR_LEASE_MECHANISM', N'PREEMPTIVE_SP_SERVER_DIAGNOSTICS',
N'PREEMPTIVE_ODBCOPS',
N'PREEMPTIVE_OS_LIBRARYOPS', N'PREEMPTIVE_OS_COMOPS', N'PREEMPTIVE_OS_CRYPTOPS',
N'PREEMPTIVE_OS_PIPEOPS', N'PREEMPTIVE_OS_AUTHENTICATIONOPS',
N'PREEMPTIVE_OS_GENERICOPS', N'PREEMPTIVE_OS_VERIFYTRUST',
N'PREEMPTIVE_OS_FILEOPS', N'PREEMPTIVE_OS_DEVICEOPS', N'PREEMPTIVE_OS_QUERYREGISTRY',
N'PREEMPTIVE_OS_WRITEFILE',
N'PREEMPTIVE_XE_CALLBACKEXECUTE', N'PREEMPTIVE_XE_DISPATCHER',
N'PREEMPTIVE_XE_GETTARGETSTATE', N'PREEMPTIVE_XE_SESSIONCOMMIT',
N'PREEMPTIVE_XE_TARGETINIT', N'PREEMPTIVE_XE_TARGETFINALIZE',
N'PREEMPTIVE_XHTTP',
N'PWAIT_ALL_COMPONENTS_INITIALIZED', N'PWAIT_DIRECTLOGCONSUMER_GETNEXT',
N'QDS_PERSIST_TASK_MAIN_LOOP_SLEEP',
N'QDS_ASYNC_QUEUE',
N'QDS_CLEANUP_STALE_QUERIES_TASK_MAIN_LOOP_SLEEP', N'REQUEST_FOR_DEADLOCK_SEARCH',
N'RESOURCE_GOVERNOR_IDLE',
N'RESOURCE_QUEUE', N'SERVER_IDLE_CHECK', N'SLEEP_BPOOL_FLUSH', N'SLEEP_DBSTARTUP',
N'SLEEP_DCOMSTARTUP', N'SLEEP_MASTERDBREADY', N'SLEEP_MASTERMDREADY',
N'SLEEP_MASTERUPGRADED', N'SLEEP_MSDBSTARTUP', N'SLEEP_SYSTEMTASK', N'SLEEP_TASK',
N'SLEEP_TEMPDBSTARTUP', N'SNI_HTTP_ACCEPT', N'SP_SERVER_DIAGNOSTICS_SLEEP',
N'SQLTRACE_BUFFER_FLUSH', N'SQLTRACE_INCREMENTAL_FLUSH_SLEEP', N'SQLTRACE_WAIT_ENTRIES',
N'WAIT_FOR_RESULTS', N'WAITFOR', N'WAITFOR_TASKSHUTDOWN', N'WAIT_XTP_HOST_WAIT',
N'WAIT_XTP_OFFLINE_CKPT_NEW_LOG', N'WAIT_XTP_CKPT_CLOSE', N'WAIT_XTP_RECOVERY',
N'XE_BUFFERMGR_ALLPROCESSED_EVENT', N'XE_DISPATCHER_JOIN',
N'XE_DISPATCHER_WAIT', N'XE_LIVE_TARGET_TVF', N'XE_TIMER_EVENT')
AND waiting_tasks_count > 0)
SELECT
MAX (W1.wait_type) AS [WaitType],
CAST (MAX (W1.Percentage) AS DECIMAL (5,2)) AS [Wait Percentage],
CAST ((MAX (W1.WaitS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgWait_Sec],
CAST ((MAX (W1.ResourceS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgRes_Sec],
CAST ((MAX (W1.SignalS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgSig_Sec],
CAST (MAX (W1.WaitS) AS DECIMAL (16,2)) AS [Total_Wait_Sec],
CAST (MAX (W1.ResourceS) AS DECIMAL (16,2)) AS [Resource_Sec],
CAST (MAX (W1.SignalS) AS DECIMAL (16,2)) AS [Signal_Sec],
MAX (W1.WaitCount) AS [Wait Count]
FROM Waits AS W1
INNER JOIN Waits AS W2
ON W2.RowNum <= W1.RowNum
GROUP BY W1.RowNum
HAVING SUM (W2.Percentage) - MAX (W1.Percentage) < 99 -- percentage threshold
OPTION (RECOMPILE);
------
-- Cumulative wait stats are not as useful on an idle instance that is not under load or performance pressure
-- SQL Server Wait Types Library (Paul Randal)
-- https://www.sqlskills.com/help/waits/
-- The SQL Server Wait Type Repository
-- http://blogs.msdn.com/b/psssql/archive/2009/11/03/the-sql-server-wait-type-repository.aspx
-- Wait statistics, or please tell me where it hurts
-- https://www.sqlskills.com/blogs/paul/wait-statistics-or-please-tell-me-where-it-hurts/
-- SQL Server 2005 Performance Tuning using the Waits and Queues
-- http://technet.microsoft.com/en-us/library/cc966413.aspx
-- sys.dm_os_wait_stats (Transact-SQL)
-- http://msdn.microsoft.com/en-us/library/ms179984(v=sql.120).aspx
-- Get most frequently executed queries for this database (Query 25) (Query Execution Counts)
SELECT TOP(50) LEFT(t.[text], 50) AS [Short Query Text], qs.execution_count AS [Execution Count],
qs.total_logical_reads AS [Total Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_worker_time AS [Total Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_elapsed_time AS [Total Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Get top total worker time queries for this database (Query 26) (Top Worker Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 50), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_worker_time AS [Total Worker Time], qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a CPU perspective for this database
-- Can also help track down parameter sniffing issues
-- Get top total logical reads queries for this database (Query 27) (Top Logical Reads Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 50), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_logical_reads AS [Total Logical Reads],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a memory perspective for this database
-- Can also help track down parameter sniffing issues
-- Get top average elapsed time queries for this database (Query 28) (Top Avg Elapsed Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.min_elapsed_time, qs.max_elapsed_time, qs.last_elapsed_time,
qs.execution_count AS [Execution Count],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_physical_reads/qs.execution_count AS [Avg Physical Reads],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
, qp.query_plan AS [Query Plan] -- comment out this column if copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.total_elapsed_time/qs.execution_count DESC OPTION (RECOMPILE);
------
-- Helps you find the highest average elapsed time queries for this database
-- Can also help track down parameter sniffing issues
-- Top Cached SPs By Execution Count (Query 29) (SP Execution Counts)
SELECT TOP(100) p.name AS [SP Name], qs.execution_count AS [Execution Count],
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Tells you which cached stored procedures are called the most often
-- This helps you characterize and baseline your workload
-- Top Cached SPs By Avg Elapsed Time (Query 30) (SP Avg Elapsed Time)
SELECT TOP(25) p.name AS [SP Name], qs.min_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
qs.max_elapsed_time, qs.last_elapsed_time, qs.total_elapsed_time, qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime],
qs.total_worker_time AS [TotalWorkerTime],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY avg_elapsed_time DESC OPTION (RECOMPILE);
------
-- This helps you find high average elapsed time cached stored procedures that
-- may be easy to optimize with standard query tuning techniques
-- Top Cached SPs By Total Worker time. Worker time relates to CPU cost (Query 31) (SP Worker Time)
SELECT TOP(25) p.name AS [SP Name], qs.total_worker_time AS [TotalWorkerTime],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a CPU perspective
-- You should look at this if you see signs of CPU pressure
-- Top Cached SPs By Total Logical Reads. Logical reads relate to memory pressure (Query 32) (SP Logical Reads)
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_reads AS [TotalLogicalReads],
qs.total_logical_reads/qs.execution_count AS [AvgLogicalReads],qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a memory perspective
-- You should look at this if you see signs of memory pressure
-- Top Cached SPs By Total Physical Reads. Physical reads relate to disk read I/O pressure (Query 33) (SP Physical Reads)
SELECT TOP(25) p.name AS [SP Name],qs.total_physical_reads AS [TotalPhysicalReads],
qs.total_physical_reads/qs.execution_count AS [AvgPhysicalReads], qs.execution_count,
qs.total_logical_reads,qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_physical_reads > 0
ORDER BY qs.total_physical_reads DESC, qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a read I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Top Cached SPs By Total Logical Writes (Query 34) (SP Logical Writes)
-- Logical writes relate to both memory and disk I/O pressure
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_writes AS [TotalLogicalWrites],
qs.total_logical_writes/qs.execution_count AS [AvgLogicalWrites], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_logical_writes > 0
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_writes DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a write I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Lists the top statements by average input/output usage for the current database (Query 35) (Top IO Statements)
SELECT TOP(50) OBJECT_NAME(qt.objectid, dbid) AS [SP Name],
(qs.total_logical_reads + qs.total_logical_writes) /qs.execution_count AS [Avg IO], qs.execution_count AS [Execution Count],
SUBSTRING(qt.[text],qs.statement_start_offset/2,
(CASE
WHEN qs.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE qs.statement_end_offset
END - qs.statement_start_offset)/2) AS [Query Text]
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(qs.sql_handle) AS qt
WHERE qt.[dbid] = DB_ID()
ORDER BY [Avg IO] DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive statements for I/O by SP
-- Possible Bad NC Indexes (writes > reads) (Query 36) (Bad NC Indexes)
SELECT OBJECT_NAME(s.[object_id]) AS [Table Name], i.name AS [Index Name], i.index_id,
i.is_disabled, i.is_hypothetical, i.has_filter, i.fill_factor,
user_updates AS [Total Writes], user_seeks + user_scans + user_lookups AS [Total Reads],
user_updates - (user_seeks + user_scans + user_lookups) AS [Difference]
FROM sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON s.[object_id] = i.[object_id]
AND i.index_id = s.index_id
WHERE OBJECTPROPERTY(s.[object_id],'IsUserTable') = 1
AND s.database_id = DB_ID()
AND user_updates > (user_seeks + user_scans + user_lookups)
AND i.index_id > 1
ORDER BY [Difference] DESC, [Total Writes] DESC, [Total Reads] ASC OPTION (RECOMPILE);
------
-- Look for indexes with high numbers of writes and zero or very low numbers of reads
-- Consider your complete workload, and how long your instance has been running
-- Investigate further before dropping an index!
-- Missing Indexes for current database by Index Advantage (Query 37) (Missing Indexes)
SELECT DISTINCT CONVERT(decimal(18,2), user_seeks * avg_total_user_cost * (avg_user_impact * 0.01)) AS [index_advantage],
migs.last_user_seek, mid.[statement] AS [Database.Schema.Table],
mid.equality_columns, mid.inequality_columns, mid.included_columns,
migs.unique_compiles, migs.user_seeks, migs.avg_total_user_cost, migs.avg_user_impact,
OBJECT_NAME(mid.[object_id]) AS [Table Name], p.rows AS [Table Rows]
FROM sys.dm_db_missing_index_group_stats AS migs WITH (NOLOCK)
INNER JOIN sys.dm_db_missing_index_groups AS mig WITH (NOLOCK)
ON migs.group_handle = mig.index_group_handle
INNER JOIN sys.dm_db_missing_index_details AS mid WITH (NOLOCK)
ON mig.index_handle = mid.index_handle
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON p.[object_id] = mid.[object_id]
WHERE mid.database_id = DB_ID()
ORDER BY index_advantage DESC OPTION (RECOMPILE);
------
-- Look at index advantage, last user seek time, number of user seeks to help determine source and importance
-- SQL Server is overly eager to add included columns, so beware
-- Do not just blindly add indexes that show up from this query!!!
-- Find missing index warnings for cached plans in the current database (Query 38) (Missing Index Warnings)
-- Note: This query could take some time on a busy instance
SELECT TOP(25) OBJECT_NAME(objectid) AS [ObjectName],
cp.objtype, cp.usecounts, cp.size_in_bytes, query_plan
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_query_plan(cp.plan_handle) AS qp
WHERE CAST(query_plan AS NVARCHAR(MAX)) LIKE N'%MissingIndex%'
AND dbid = DB_ID()
ORDER BY cp.usecounts DESC OPTION (RECOMPILE);
------
-- Helps you connect missing indexes to specific stored procedures or queries
-- This can help you decide whether to add them or not
-- Breaks down buffers used by current database by object (table, index) in the buffer cache (Query 39) (Buffer Usage)
-- Note: This query could take some time on a busy instance
SELECT OBJECT_NAME(p.[object_id]) AS [Object Name], p.index_id,
CAST(COUNT(*)/128.0 AS DECIMAL(10, 2)) AS [Buffer size(MB)],
COUNT(*) AS [BufferCount], p.[Rows] AS [Row Count],
p.data_compression_desc AS [Compression Type]
FROM sys.allocation_units AS a WITH (NOLOCK)
INNER JOIN sys.dm_os_buffer_descriptors AS b WITH (NOLOCK)
ON a.allocation_unit_id = b.allocation_unit_id
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON a.container_id = p.hobt_id
WHERE b.database_id = CONVERT(int, DB_ID())
AND p.[object_id] > 100
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'plan_%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'sys%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'xml_index_nodes%'
GROUP BY p.[object_id], p.index_id, p.data_compression_desc, p.[Rows]
ORDER BY [BufferCount] DESC OPTION (RECOMPILE);
------
-- Tells you what tables and indexes are using the most memory in the buffer cache
-- It can help identify possible candidates for data compression
-- Get Table names, row counts, and compression status for clustered index or heap (Query 40) (Table Sizes)
SELECT OBJECT_NAME(object_id) AS [ObjectName],
SUM(Rows) AS [RowCount], data_compression_desc AS [CompressionType]
FROM sys.partitions WITH (NOLOCK)
WHERE index_id < 2 --ignore the partitions from the non-clustered index if any
AND OBJECT_NAME(object_id) NOT LIKE N'sys%'
AND OBJECT_NAME(object_id) NOT LIKE N'queue_%'
AND OBJECT_NAME(object_id) NOT LIKE N'filestream_tombstone%'
AND OBJECT_NAME(object_id) NOT LIKE N'fulltext%'
AND OBJECT_NAME(object_id) NOT LIKE N'ifts_comp_fragment%'
AND OBJECT_NAME(object_id) NOT LIKE N'filetable_updates%'
AND OBJECT_NAME(object_id) NOT LIKE N'xml_index_nodes%'
AND OBJECT_NAME(object_id) NOT LIKE N'sqlagent_job%'
AND OBJECT_NAME(object_id) NOT LIKE N'plan_persist%'
AND OBJECT_NAME(object_id) NOT LIKE N'persistent_version%'
AND OBJECT_NAME(object_id) NOT LIKE N'database_firewall%'
AND OBJECT_NAME(object_id) NOT LIKE N'wpr_bucket%'
GROUP BY object_id, data_compression_desc
ORDER BY SUM(Rows) DESC OPTION (RECOMPILE);
------
-- Gives you an idea of table sizes, and possible data compression opportunities
-- Get some key table properties (Query 41) (Table Properties)
SELECT OBJECT_NAME(t.[object_id]) AS [ObjectName], p.[rows] AS [Table Rows], p.index_id,
p.data_compression_desc AS [Index Data Compression],
t.create_date, t.lock_on_bulk_load,
t.is_tracked_by_cdc, t.lock_escalation_desc, t.is_filetable,
t.is_memory_optimized, t.durability_desc,
t.temporal_type_desc
FROM sys.tables AS t WITH (NOLOCK)
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON t.[object_id] = p.[object_id]
WHERE OBJECT_NAME(t.[object_id]) NOT LIKE N'sys%'
ORDER BY OBJECT_NAME(t.[object_id]), p.index_id OPTION (RECOMPILE);
------
-- Gives you some good information about your tables
-- is_memory_optimized and durability_desc were new in SQL Server 2014
-- temporal_type_desc, is_remote_data_archive_enabled, is_external are new in SQL Server 2016
-- sys.tables (Transact-SQL)
-- https://bit.ly/2Gk7998
-- When were Statistics last updated on all indexes? (Query 42) (Statistics Update)
SELECT SCHEMA_NAME(o.Schema_ID) + N'.' + o.[NAME] AS [Object Name], o.[type_desc] AS [Object Type],
i.[name] AS [Index Name], STATS_DATE(i.[object_id], i.index_id) AS [Statistics Date],
s.auto_created, s.no_recompute, s.user_created, s.is_incremental, s.is_temporary,
st.row_count, st.used_page_count
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON o.[object_id] = i.[object_id]
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.stats_id
INNER JOIN sys.dm_db_partition_stats AS st WITH (NOLOCK)
ON o.[object_id] = st.[object_id]
AND i.[index_id] = st.[index_id]
WHERE o.[type] IN ('U', 'V')
AND st.row_count > 0
ORDER BY STATS_DATE(i.[object_id], i.index_id) DESC OPTION (RECOMPILE);
------
-- Helps discover possible problems with out-of-date statistics
-- Also gives you an idea which indexes are the most active
-- sys.stats (Transact-SQL)
-- https://bit.ly/2GyAxrn
-- Look at most frequently modified indexes and statistics (Query 43) (Volatile Indexes)
SELECT o.[name] AS [Object Name], o.[object_id], o.[type_desc], s.[name] AS [Statistics Name],
s.stats_id, s.no_recompute, s.auto_created, s.is_incremental, s.is_temporary,
sp.modification_counter, sp.[rows], sp.rows_sampled, sp.last_updated
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON s.object_id = o.object_id
CROSS APPLY sys.dm_db_stats_properties(s.object_id, s.stats_id) AS sp
WHERE o.[type_desc] NOT IN (N'SYSTEM_TABLE', N'INTERNAL_TABLE')
AND sp.modification_counter > 0
ORDER BY sp.modification_counter DESC, o.name OPTION (RECOMPILE);
------
-- This helps you understand your workload and make better decisions about
-- things like data compression and adding new indexes to a table
-- Get fragmentation info for all indexes above a certain size in the current database (Query 44) (Index Fragmentation)
-- Note: This query could take some time on a very large database
SELECT DB_NAME(ps.database_id) AS [Database Name], SCHEMA_NAME(o.[schema_id]) AS [Schema Name],
OBJECT_NAME(ps.OBJECT_ID) AS [Object Name], i.[name] AS [Index Name], ps.index_id,
ps.index_type_desc, ps.avg_fragmentation_in_percent,
ps.fragment_count, ps.page_count, i.fill_factor, i.has_filter,
i.filter_definition, i.[allow_page_locks]
FROM sys.dm_db_index_physical_stats(DB_ID(),NULL, NULL, NULL , N'LIMITED') AS ps
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.[object_id] = i.[object_id]
AND ps.index_id = i.index_id
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON i.[object_id] = o.[object_id]
WHERE ps.database_id = DB_ID()
AND ps.page_count > 2500
ORDER BY ps.avg_fragmentation_in_percent DESC OPTION (RECOMPILE);
------
-- Helps determine whether you have framentation in your relational indexes
-- and how effective your index maintenance strategy is
--- Index Read/Write stats (all tables in current DB) ordered by Reads (Query 45) (Overall Index Usage - Reads)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_seeks, s.user_scans, s.user_lookups,
s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
s.user_updates AS [Writes],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_user_scan, s.last_user_lookup, s.last_user_seek
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_seeks + s.user_scans + s.user_lookups DESC OPTION (RECOMPILE); -- Order by reads
------
-- Show which indexes in the current database are most active for Reads
--- Index Read/Write stats (all tables in current DB) ordered by Writes (Query 46) (Overall Index Usage - Writes)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_updates AS [Writes], s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_system_update, s.last_user_update
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_updates DESC OPTION (RECOMPILE); -- Order by writes
------
-- Show which indexes in the current database are most active for Writes
-- Get in-memory OLTP index usage (Query 47) (XTP Index Usage)
SELECT OBJECT_NAME(i.[object_id]) AS [Object Name], i.index_id, i.[name] AS [Index Name],
i.[type_desc], xis.scans_started, xis.scans_retries,
xis.rows_touched, xis.rows_returned
FROM sys.dm_db_xtp_index_stats AS xis WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON i.[object_id] = xis.[object_id]
AND i.index_id = xis.index_id
ORDER BY OBJECT_NAME(i.[object_id]) OPTION (RECOMPILE);
------
-- This gives you some index usage statistics for in-memory OLTP
-- Returns no data if you are not using in-memory OLTP
-- Guidelines for Using Indexes on Memory-Optimized Tables
-- https://bit.ly/2GCP8lF
-- Look at Columnstore index physical statistics (Query 48) (Columnstore Index Physical Stat)
SELECT OBJECT_NAME(ps.object_id) AS [TableName],
i.[name] AS [IndexName], ps.index_id, ps.partition_number,
ps.delta_store_hobt_id, ps.state_desc, ps.total_rows, ps.size_in_bytes,
ps.trim_reason_desc, ps.generation, ps.transition_to_compressed_state_desc,
ps.has_vertipaq_optimization, ps.deleted_rows,
100 * (ISNULL(ps.deleted_rows, 0))/ps.total_rows AS [Fragmentation]
FROM sys.dm_db_column_store_row_group_physical_stats AS ps WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.object_id = i.object_id
AND ps.index_id = i.index_id
ORDER BY ps.object_id, ps.partition_number, ps.row_group_id OPTION (RECOMPILE);
------
-- sys.dm_db_column_store_row_group_physical_stats (Transact-SQL)
-- https://bit.ly/2q276XQ
-- Get lock waits for current database (Query 49) (Lock Waits)
SELECT o.name AS [table_name], i.name AS [index_name], ios.index_id, ios.partition_number,
SUM(ios.row_lock_wait_count) AS [total_row_lock_waits],
SUM(ios.row_lock_wait_in_ms) AS [total_row_lock_wait_in_ms],
SUM(ios.page_lock_wait_count) AS [total_page_lock_waits],
SUM(ios.page_lock_wait_in_ms) AS [total_page_lock_wait_in_ms],
SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) AS [total_lock_wait_in_ms]
FROM sys.dm_db_index_operational_stats(DB_ID(), NULL, NULL, NULL) AS ios
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON ios.[object_id] = o.[object_id]
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ios.[object_id] = i.[object_id]
AND ios.index_id = i.index_id
WHERE o.[object_id] > 100
GROUP BY o.name, i.name, ios.index_id, ios.partition_number
HAVING SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) > 0
ORDER BY total_lock_wait_in_ms DESC OPTION (RECOMPILE);
------
-- This query is helpful for troubleshooting blocking and deadlocking issues
-- Look at UDF execution statistics (Query 50) (UDF Statistics)
SELECT OBJECT_NAME(object_id) AS [Function Name], total_worker_time,
execution_count, total_elapsed_time,
total_elapsed_time/execution_count AS [avg_elapsed_time],
last_elapsed_time, last_execution_time, cached_time
FROM sys.dm_exec_function_stats WITH (NOLOCK)
WHERE database_id = DB_ID()
ORDER BY total_worker_time DESC OPTION (RECOMPILE);
------
-- Helps you investigate scalar UDF performance issues
-- sys.dm_exec_function_stats (Transact-SQL)
-- https://bit.ly/2q1Q6BM
-- Get QueryStore Options for this database (Query 51) (QueryStore Options)
SELECT actual_state_desc, desired_state_desc,
current_storage_size_mb, [max_storage_size_mb],
query_capture_mode_desc, size_based_cleanup_mode_desc
FROM sys.database_query_store_options WITH (NOLOCK) OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that QueryStore is enabled for this database
-- Tuning Workload Performance with Query Store
-- https://bit.ly/1kHSl7w
-- Get highest aggregate duration queries over last hour (Query 52) (High Aggregate Duration Queries)
WITH AggregatedDurationLastHour
AS
(SELECT q.query_id, SUM(count_executions * avg_duration) AS total_duration,
COUNT (distinct p.plan_id) AS number_of_plans
FROM sys.query_store_query_text AS qt WITH (NOLOCK)
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON qt.query_text_id = q.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
INNER JOIN sys.query_store_runtime_stats AS rs WITH (NOLOCK)
ON rs.plan_id = p.plan_id
INNER JOIN sys.query_store_runtime_stats_interval AS rsi WITH (NOLOCK)
ON rsi.runtime_stats_interval_id = rs.runtime_stats_interval_id
WHERE rsi.start_time >= DATEADD(hour, -1, GETUTCDATE())
AND rs.execution_type_desc = N'Regular'
GROUP BY q.query_id),
OrderedDuration AS
(SELECT query_id, total_duration, number_of_plans,
ROW_NUMBER () OVER (ORDER BY total_duration DESC, query_id) AS RN
FROM AggregatedDurationLastHour)
SELECT OBJECT_NAME(q.object_id) AS [Containing Object], qt.query_sql_text,
od.total_duration AS [Total Duration (microsecs)],
od.number_of_plans AS [Plan Count],
p.is_forced_plan, p.is_parallel_plan, p.is_trivial_plan,
q.query_parameterization_type_desc, p.[compatibility_level],
p.last_compile_start_time, q.last_execution_time,
CONVERT(xml, p.query_plan) AS query_plan_xml
FROM OrderedDuration AS od
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON q.query_id = od.query_id
INNER JOIN sys.query_store_query_text AS qt WITH (NOLOCK)
ON q.query_text_id = qt.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
WHERE od.RN <= 50
ORDER BY total_duration DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that QueryStore is enabled for this database
-- Get input buffer information for the current database (Query 53) (Input Buffer)
SELECT es.session_id, DB_NAME(es.database_id) AS [Database Name],
es.login_time, es.cpu_time, es.logical_reads,
es.[status], ib.event_info AS [Input Buffer]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
CROSS APPLY sys.dm_exec_input_buffer(es.session_id, NULL) AS ib
WHERE es.database_id = DB_ID()
AND es.session_id > 50
AND es.session_id <> @@SPID OPTION (RECOMPILE);
------
-- Gives you input buffer information from all non-system sessions for the current database
-- Replaces DBCC INPUTBUFFER
-- New DMF for retrieving input buffer in SQL Server
-- https://bit.ly/2uHKMbz
-- Get any resumable index rebuild operation information (Query 54) (Resumable Index Rebuild)
SELECT OBJECT_NAME(iro.object_id) AS [Object Name], iro.index_id, iro.name AS [Index Name],
iro.sql_text, iro.last_max_dop_used, iro.partition_number, iro.state_desc, iro.start_time, iro.percent_complete
FROM sys.index_resumable_operations AS iro WITH (NOLOCK)
OPTION (RECOMPILE);
------
-- index_resumable_operations (Transact-SQL)
-- https://bit.ly/2pYSWqq
-- Get database automatic tuning options (Query 55) (Automatic Tuning Options)
SELECT [name], desired_state_desc, actual_state_desc, reason_desc
FROM sys.database_automatic_tuning_options WITH (NOLOCK)
OPTION (RECOMPILE);
------
-- sys.database_automatic_tuning_options (Transact-SQL)
-- https://bit.ly/2FHhLkL
-- Get geo-replication link status for all secondary databases (Query 56) (Geo-Replication Link Status)
SELECT link_guid, partner_server, partner_database, last_replication,
replication_lag_sec, replication_state_desc, role_desc, secondary_allow_connections_desc
FROM sys.dm_geo_replication_link_status WITH (NOLOCK) OPTION (RECOMPILE);
------
-- sys.dm_geo_replication_link_status (Azure SQL Database)
-- https://bit.ly/2GwIqC2
-- Retrieve some Azure SQL Database properties (Query 57) (Azure SQL DB Properties)
SELECT DATABASEPROPERTYEX (DB_NAME(DB_ID()), 'Edition') AS [Database Edition],
DATABASEPROPERTYEX (DB_NAME(DB_ID()), 'ServiceObjective') AS [Service Objective],
DATABASEPROPERTYEX (DB_NAME(DB_ID()), 'MaxSizeInBytes') AS [Max Size In Bytes],
DATABASEPROPERTYEX (DB_NAME(DB_ID()), 'IsXTPSupported') AS [Is XTP Supported]
OPTION (RECOMPILE);
------
-- DATABASEPROPERTYEX (Transact-SQL)
-- https://bit.ly/2ItexPg
-- Sign up for Microsoft Visual Studio Dev Essentials and get a free three month pass to Pluralsight
-- Microsoft Visual Studio Dev Essentials
-- https://bit.ly/1q6xbDL
-- Sign up for Microsoft Azure Essentials and get lots of free Azure usage credits, MCP exam voucher, three month Pluralsight subscription
-- Microsoft Azure Essentials
-- https://bit.ly/2KH91dQ
md5: FC53B66F0B862A05CF533B44A1CAEDBB | sha1: 5E5BD9F1A9E6D8EA047E17BE5BE2D387CA1AB8E9 | sha256: 3594B22AB2FD554E1890B48D5E64C0A6A70A0CABD00B7453E8C921C11C08D5E6 | sha512: D45E01CA7A48124667FAA37A51F9452E95E69DC72C718D583E17A77888976C6B8378ED82CF0B9DB7BF1177E8D77FB0FC5A04846396D70867DA45BFCBE2DEB592
md5: F4B84B1EB2711575D6AB68576A1C9027 | sha1: D827A68F25AC23D72A0028A825A304BDF98B2517 | sha256: 2380C3B549B96BF791C735894D2D25CF102DD0094118337C4B4AFC60CFDE5812 | sha512: 8D252EC540CBFBBCE08A73ABD4E19908EBC02EA3CD46D34FD8EAA983DBBF8C5185A462FBDAF84A0583E1EDF98AD0E357D9F605AA3488B728A9AD9D0C817954A9
md5: 2ACB72F8B7FFFB8D53BC79C412FBD19A | sha1: 6B54CBF8F4305176C4F11737D75FA54C5D694904 | sha256: EAF198781427C8F148022C38FA89E8D6E77DCAD420F5EFC028FAB3E45452D7A3 | sha512: D3AABA6CFE2C6E84E6C04C46E4B9022DAE1B130A95E0D3442EF9F44A9300ED03A17022CFD575DD1FA1A6C188E2B92728293027011C0CB115488B335584473F47
md5: FCAA6034315522B0A10F18B522A89602 | sha1: F6990976F55616AA986CCEC2719BDB17FA9C00C3 | sha256: 7C8FD89AF1C118D5DC0C46BEC6484358467E6EA278EFB8C5B4CA6B63C62B717D | sha512: 6D622B81BE12A2079BFE7724A5892245F43CEC0581EEFBA33B8A7241AF6E80DD58D239E7D2A42C47E499591865C3A098984C218ED74F6303B559067049E90EEA
md5: 8C454E6D06D56C19F355F702B15EBB15 | sha1: 6D4322B7BC25A50E0C5EFC80DD71824592D3A040 | sha256: 3A1475D6F1A99AB2A85AFEDFF3DB6454D901EBF1DE1D58E294EA2CB16516648A | sha512: 6D1C221430668BE2C7DAAE9D27AAA621038F8F52F5AC3CF9A6D02D10F33E85718E08017E5CF6CDB9E2CB10CE66EB9212DCC6C88FB17C4FB486C7D71720B6BDFB
md5: 383FE8CAD1F26D4A307FFD490B96D307 | sha1: B5D13E6B49B72825627B44C3501091A12580F741 | sha256: 2488A00E8045A929110BC35F4719D40C653C89F1799CB97767CB01FE94CF3E3B | sha512: E8F7A59764BE375BED343E3F60F12A7537973DA219D2101796CCCD455EB70ECD8AF784C0A2A7D96D7FB3D6A4DA73C784889DEC086019CF0D26CB700E738BB042
md5: F631F51807B66AC4E3C9869122FC1309 | sha1: 496EBB02213A694101849ADFCE095F4671459D5B | sha256: 9E635E1F33493D570A5C42B394450569B14FF418026FE530CA364FC4AB395778 | sha512: 26FB696407D8218E80995732FA176BD7EDE900C358004AF4B7F5D359863A4ABC1B9462B6BCA3540C72A6A342CFED962252B06D58B63A469148EA48AE6D47AF53
md5: FB02906D3F269BEEB3035CCA0F411E61 | sha1: 204B41159B0A875D24CD5762A98C6CC474A44CE2 | sha256: 5D97EC841E7A696EA54BEB6E499F52B203DED61335C82D63DE2D72C3FCD9121E | sha512: 6F5F9FB92A30038C9839E2524682ED45F0A96604E496D24B3D62E06B2D643CEB8AFD24A641B0DB0C89E52624F5C198033BE482F2539F6F0F29ED9208F56A9C9E
-- SQL Server 2017 Diagnostic Information Queries
-- Glenn Berry
-- Last Modified: September 13, 2018
-- https://www.sqlskills.com/blogs/glenn/
-- http://sqlserverperformance.wordpress.com/
-- Twitter: GlennAlanBerry
-- Please listen to my Pluralsight courses
-- https://www.pluralsight.com/author/glenn-berry
-- If you want to find all of our SQLskills SQL101 blog posts, check out https://bit.ly/2qLwfXW
-- Please make sure you are using the correct version of these diagnostic queries for your version of SQL Server
-- If you like PowerShell, there is a very useful community solution for running these queries in an automated fashion
-- https://dbatools.io/
-- Invoke-DbaDiagnosticQuery
-- https://dbatools.io/functions/invoke-dbadiagnosticquery/
--******************************************************************************
--* Copyright (C) 2018 Glenn Berry, SQLskills.com
--* All rights reserved.
--*
--* For more scripts and sample code, check out
--* https://www.sqlskills.com/blogs/glenn
--*
--* You may alter this code for your own *non-commercial* purposes. You may
--* republish altered code as long as you include this copyright and give due credit.
--*
--*
--* THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF
--* ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED
--* TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
--* PARTICULAR PURPOSE.
--*
--******************************************************************************
-- Check the major product version to see if it is SQL Server 2017 CTP 1 or greater
IF NOT EXISTS (SELECT * WHERE CONVERT(varchar(128), SERVERPROPERTY('ProductVersion')) LIKE '14%')
BEGIN
DECLARE @ProductVersion varchar(128) = CONVERT(varchar(128), SERVERPROPERTY('ProductVersion'));
RAISERROR ('Script does not match the ProductVersion [%s] of this instance. Many of these queries may not work on this version.' , 18 , 16 , @ProductVersion);
END
ELSE
PRINT N'You have the correct major version of SQL Server for this diagnostic information script';
-- Instance level queries *******************************
-- SQL and OS Version information for current instance (Query 1) (Version Info)
SELECT @@SERVERNAME AS [Server Name], @@VERSION AS [SQL Server and OS Version Info];
------
-- SQL Server 2017 Builds
-- Build Description Release Date URL to KB Article
-- 14.0.1.246 CTP 1.0 11/30/2016
-- 14.0.100.187 CTP 1.1 12/16/2016
-- 14.0.200.24 CTP 1.2 1/19/2017
-- 14.0.304.138 CTP 1.3 2/17/2017
-- 14.0.405.198 CTP 1.4 3/20/2017
-- 14.0.500.272 CTP 2.0 4/19/2017
-- 14.0.600.250 CTP 2.1 5/17/2017
-- 14.0.800.90 RC1 7/17/2017
-- 14.0.900.75 RC2 8/2/2017
-- 14.0.1000.169 RTM 10/2/2017
-- 14.0.3006.16 CU1 10/24/2017 https://support.microsoft.com/en-us/help/4038634
-- 14.0.3008.27 CU2 11/28/2017 https://support.microsoft.com/en-us/help/4052574
-- 14.0.3015.40 CU3 1/4/2018 https://support.microsoft.com/en-us/help/4052987
-- 14.0.3022.28 CU4 2/20/2018 https://support.microsoft.com/en-us/help/4056498
-- 14.0.3023.8 CU5 3/20/2018 https://support.microsoft.com/en-us/help/4092643
-- 14.0.3025.34 CU6 4/17/2018 https://support.microsoft.com/en-us/help/4101464
-- 14.0.3026.27 CU7 5/23/2018 https://support.microsoft.com/en-us/help/4229789
-- 14.0.3029.16 CU8 6/19/2018 https://support.microsoft.com/en-us/help/4338363
-- 14.0.3030.27 CU9 7/19/2018 https://support.microsoft.com/en-us/help/4341265
-- 14.0.3035.2 CU9 + Security Update 8/13/2018 https://www.microsoft.com/en-us/download/details.aspx?id=57263
-- 14.0.3037.1 CU10 8/27/2018 https://support.microsoft.com/en-us/help/4342123/cumulative-update-10-for-sql-server-2017
-- How to determine the version, edition and update level of SQL Server and its components
-- https://bit.ly/2oAjKgW
-- SQL Server 2017 build versions
-- https://bit.ly/2FLY88I
-- Performance and Stability Fixes in SQL Server 2017 CU Builds
-- https://bit.ly/2GV3CNM
-- What's New in SQL Server 2017 (Database Engine)
-- https://bit.ly/2HjSeyQ
-- What's New in SQL Server 2017
-- https://bit.ly/2saQ4Yh
-- Announcing the Modern Servicing Model for SQL Server
-- https://bit.ly/2xHnh0l
-- SQL Server Service Packs are discontinued starting from SQL Server 2017
-- https://bit.ly/2GTkbgt
-- Update Center for Microsoft SQL Server
-- https://bit.ly/2pZptuQ
-- Download SQL Server Management Studio (SSMS)
-- https://bit.ly/1OcupT9
-- Download and install Microsoft SQL Operations Studio
-- https://bit.ly/2vgke1A
-- Get socket, physical core and logical core count from the SQL Server Error log. (Query 2) (Core Counts)
-- This query might take a few seconds depending on the size of your error log
EXEC sys.xp_readerrorlog 0, 1, N'detected', N'socket';
------
-- This can help you determine the exact core counts used by SQL Server and whether HT is enabled or not
-- It can also help you confirm your SQL Server licensing model
-- Be on the lookout for this message "using 40 logical processors based on SQL Server licensing"
-- (when you have more than 40 logical cores) which means grandfathered Server/CAL licensing
-- This query will return no results if your error log has been recycled since the instance was last started
-- Get selected server properties (Query 3) (Server Properties)
SELECT SERVERPROPERTY('MachineName') AS [MachineName],
SERVERPROPERTY('ServerName') AS [ServerName],
SERVERPROPERTY('InstanceName') AS [Instance],
SERVERPROPERTY('IsClustered') AS [IsClustered],
SERVERPROPERTY('ComputerNamePhysicalNetBIOS') AS [ComputerNamePhysicalNetBIOS],
SERVERPROPERTY('Edition') AS [Edition],
SERVERPROPERTY('ProductLevel') AS [ProductLevel], -- What servicing branch (RTM/SP/CU)
SERVERPROPERTY('ProductUpdateLevel') AS [ProductUpdateLevel], -- Within a servicing branch, what CU# is applied
SERVERPROPERTY('ProductVersion') AS [ProductVersion],
SERVERPROPERTY('ProductMajorVersion') AS [ProductMajorVersion],
SERVERPROPERTY('ProductMinorVersion') AS [ProductMinorVersion],
SERVERPROPERTY('ProductBuild') AS [ProductBuild],
SERVERPROPERTY('ProductBuildType') AS [ProductBuildType], -- Is this a GDR or OD hotfix (NULL if on a CU build)
SERVERPROPERTY('ProductUpdateReference') AS [ProductUpdateReference], -- KB article number that is applicable for this build
SERVERPROPERTY('ProcessID') AS [ProcessID],
SERVERPROPERTY('Collation') AS [Collation],
SERVERPROPERTY('IsFullTextInstalled') AS [IsFullTextInstalled],
SERVERPROPERTY('IsIntegratedSecurityOnly') AS [IsIntegratedSecurityOnly],
SERVERPROPERTY('FilestreamConfiguredLevel') AS [FilestreamConfiguredLevel],
SERVERPROPERTY('IsHadrEnabled') AS [IsHadrEnabled],
SERVERPROPERTY('HadrManagerStatus') AS [HadrManagerStatus],
SERVERPROPERTY('InstanceDefaultDataPath') AS [InstanceDefaultDataPath],
SERVERPROPERTY('InstanceDefaultLogPath') AS [InstanceDefaultLogPath],
SERVERPROPERTY('BuildClrVersion') AS [Build CLR Version],
SERVERPROPERTY('IsXTPSupported') AS [IsXTPSupported],
SERVERPROPERTY('IsPolybaseInstalled') AS [IsPolybaseInstalled], -- New for SQL Server 2016
SERVERPROPERTY('IsAdvancedAnalyticsInstalled') AS [IsRServicesInstalled]; -- New for SQL Server 2016
------
-- This gives you a lot of useful information about your instance of SQL Server,
-- such as the ProcessID for SQL Server and your collation
-- Note: Some columns will be NULL on older SQL Server builds
-- SERVERPROPERTY (Transact-SQL)
-- https://bit.ly/2eeaXeI
-- Get instance-level configuration values for instance (Query 4) (Configuration Values)
SELECT name, value, value_in_use, minimum, maximum, [description], is_dynamic, is_advanced
FROM sys.configurations WITH (NOLOCK)
ORDER BY name OPTION (RECOMPILE);
------
-- Focus on these settings:
-- automatic soft-NUMA disabled (should be 0 in most cases)
-- backup checksum default (should be 1)
-- backup compression default (should be 1 in most cases)
-- clr enabled (only enable if it is needed)
-- cost threshold for parallelism (depends on your workload)
-- lightweight pooling (should be zero)
-- max degree of parallelism (depends on your workload and hardware)
-- max server memory (MB) (set to an appropriate value, not the default)
-- optimize for ad hoc workloads (should be 1)
-- priority boost (should be zero)
-- remote admin connections (should be 1)
-- New configuration options for SQL Server 2017
-- clr strict security is new in SQL Server 2017, and is enabled by default
-- sys.configurations (Transact-SQL)
-- https://bit.ly/2HsyDZI
-- Returns a list of all global trace flags that are enabled (Query 5) (Global Trace Flags)
DBCC TRACESTATUS (-1);
------
-- If no global trace flags are enabled, no results will be returned.
-- It is very useful to know what global trace flags are currently enabled as part of the diagnostic process.
-- Common trace flags that should be enabled in most cases
-- TF 3226 - Supresses logging of successful database backup messages to the SQL Server Error Log
-- https://bit.ly/2p6MTjS
-- TF 6534 - Enables use of native code to improve performance with spatial data
-- https://bit.ly/2HrQUpU
-- The behavior of TF 1117, 1118 are enabled for tempdb in SQL Server 2016 by default
-- SQL 2016 � It Just Runs Faster: -T1117 and -T1118 changes for TEMPDB and user databases
-- https://bit.ly/2lbNWxK
-- The behavior of TF 2371 is enabled by default in SQL Server 2016 and newer (in compat level 130 and higher)
-- DBCC TRACEON - Trace Flags (Transact-SQL)
-- https://bit.ly/2FuSvPg
-- Returns status of instant file initialization (Query 6) (IFI Status)
EXEC sys.xp_readerrorlog 0, 1, N'Database Instant File Initialization';
------
-- Lets you determine whether Instant File Initialization (IFI) is enabled for the instance
-- This should be enabled in the vast majority of cases
-- SQL Server 2016 and newer lets you enable this during the SQL server installation process
-- Database Instant File Initialization
-- https://bit.ly/2nTX74y
-- Misconceptions around instant file initialization
-- https://bit.ly/2oBSKgZ
-- SQL Server Process Address space info (Query 7) (Process Memory)
-- (shows whether locked pages is enabled, among other things)
SELECT physical_memory_in_use_kb/1024 AS [SQL Server Memory Usage (MB)],
locked_page_allocations_kb/1024 AS [SQL Server Locked Pages Allocation (MB)],
large_page_allocations_kb/1024 AS [SQL Server Large Pages Allocation (MB)],
page_fault_count, memory_utilization_percentage, available_commit_limit_kb,
process_physical_memory_low, process_virtual_memory_low
FROM sys.dm_os_process_memory WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You want to see 0 for process_physical_memory_low
-- You want to see 0 for process_virtual_memory_low
-- This indicates that you are not under internal memory pressure
-- If locked_page_allocations_kb > 0, then LPIM is enabled
-- How to enable the "locked pages" feature in SQL Server 2012
-- https://bit.ly/2F5UjOA
-- Memory Management Architecture Guide
-- https://bit.ly/2JKkadC
-- SQL Server Services information (Query 8) (SQL Server Services Info)
SELECT servicename, process_id, startup_type_desc, status_desc,
last_startup_time, service_account, is_clustered, cluster_nodename, [filename],
instant_file_initialization_enabled
FROM sys.dm_server_services WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Tells you the account being used for the SQL Server Service and the SQL Agent Service
-- Shows the process_id, when they were last started, and their current status
-- Also shows whether you are running on a failover cluster instance, and what node you are running on
-- Also shows whether IFI is enabled
-- sys.dm_server_services (Transact-SQL)
-- https://bit.ly/2oKa1Un
-- Last backup information by database (Query 9) (Last Backup By Database)
SELECT ISNULL(d.[name], bs.[database_name]) AS [Database], d.recovery_model_desc AS [Recovery Model],
d.log_reuse_wait_desc AS [Log Reuse Wait Desc],
MAX(CASE WHEN [type] = 'D' THEN bs.backup_finish_date ELSE NULL END) AS [Last Full Backup],
MAX(CASE WHEN [type] = 'I' THEN bs.backup_finish_date ELSE NULL END) AS [Last Differential Backup],
MAX(CASE WHEN [type] = 'L' THEN bs.backup_finish_date ELSE NULL END) AS [Last Log Backup]
FROM sys.databases AS d WITH (NOLOCK)
LEFT OUTER JOIN msdb.dbo.backupset AS bs WITH (NOLOCK)
ON bs.[database_name] = d.[name]
AND bs.backup_finish_date > GETDATE()- 30
WHERE d.name <> N'tempdb'
GROUP BY ISNULL(d.[name], bs.[database_name]), d.recovery_model_desc, d.log_reuse_wait_desc, d.[name]
ORDER BY d.recovery_model_desc, d.[name] OPTION (RECOMPILE);
------
-- This helps you spot runaway transaction logs and other issues with your backup schedule
-- Get SQL Server Agent jobs and Category information (Query 10) (SQL Server Agent Jobs)
SELECT sj.name AS [Job Name], sj.[description] AS [Job Description], SUSER_SNAME(sj.owner_sid) AS [Job Owner],
sj.date_created AS [Date Created], sj.[enabled] AS [Job Enabled],
sj.notify_email_operator_id, sj.notify_level_email, sc.name AS [CategoryName],
s.[enabled] AS [Sched Enabled], js.next_run_date, js.next_run_time
FROM msdb.dbo.sysjobs AS sj WITH (NOLOCK)
INNER JOIN msdb.dbo.syscategories AS sc WITH (NOLOCK)
ON sj.category_id = sc.category_id
LEFT OUTER JOIN msdb.dbo.sysjobschedules AS js WITH (NOLOCK)
ON sj.job_id = js.job_id
LEFT OUTER JOIN msdb.dbo.sysschedules AS s WITH (NOLOCK)
ON js.schedule_id = s.schedule_id
ORDER BY sj.name OPTION (RECOMPILE);
------
-- Gives you some basic information about your SQL Server Agent jobs, who owns them and how they are configured
-- Look for Agent jobs that are not owned by sa
-- Look for jobs that have a notify_email_operator_id set to 0 (meaning no operator)
-- Look for jobs that have a notify_level_email set to 0 (meaning no e-mail is ever sent)
--
-- MSDN sysjobs documentation
-- https://bit.ly/2paDEOP
-- SQL Server Maintenance Solution
-- https://bit.ly/1pgchQu
-- Get SQL Server Agent Alert Information (Query 11) (SQL Server Agent Alerts)
SELECT name, event_source, message_id, severity, [enabled], has_notification,
delay_between_responses, occurrence_count, last_occurrence_date, last_occurrence_time
FROM msdb.dbo.sysalerts WITH (NOLOCK)
ORDER BY name OPTION (RECOMPILE);
------
-- Gives you some basic information about your SQL Server Agent Alerts
-- (which are different from SQL Server Agent jobs)
-- Read more about Agent Alerts here: https://bit.ly/2Giz0Xf
-- Host information (Query 12) (Host Info)
SELECT host_platform, host_distribution, host_release,
host_service_pack_level, host_sku, os_language_version
FROM sys.dm_os_host_info WITH (NOLOCK) OPTION (RECOMPILE);
------
-- host_release codes (only valid for Windows)
-- 10.0 is either Windows 10 or Windows Server 2016
-- 6.3 is either Windows 8.1 or Windows Server 2012 R2
-- 6.2 is either Windows 8 or Windows Server 2012
-- host_sku codes (only valid for Windows)
-- 4 is Enterprise Edition
-- 7 is Standard Server Edition
-- 8 is Datacenter Server Edition
-- 10 is Enterprise Server Edition
-- 48 is Professional Edition
-- 161 is Pro for Workstations
-- 1033 for os_language_version is US-English
-- SQL Server 2017 requires Windows Server 2012 or newer
-- Hardware and Software Requirements for Installing SQL Server
-- https://bit.ly/2y3ka5L
-- Using SQL Server in Windows 8 and later versions of Windows operating system
-- https://bit.ly/2F7Ax0P
-- SQL Server NUMA Node information (Query 13) (SQL Server NUMA Info)
SELECT node_id, node_state_desc, memory_node_id, processor_group, cpu_count, online_scheduler_count,
idle_scheduler_count, active_worker_count, avg_load_balance, resource_monitor_state
FROM sys.dm_os_nodes WITH (NOLOCK)
WHERE node_state_desc <> N'ONLINE DAC' OPTION (RECOMPILE);
------
-- Gives you some useful information about the composition and relative load on your NUMA nodes
-- You want to see an equal number of schedulers on each NUMA node
-- Watch out if SQL Server 2017 Standard Edition has been installed
-- on a physical or virtual machine with more than four sockets or more than 24 physical cores
-- sys.dm_os_nodes (Transact-SQL)
-- https://bit.ly/2pn5Mw8
-- Balancing Your Available SQL Server Core Licenses Evenly Across NUMA Nodes
-- https://bit.ly/2vfC4Rq
-- Good basic information about OS memory amounts and state (Query 14) (System Memory)
SELECT total_physical_memory_kb/1024 AS [Physical Memory (MB)],
available_physical_memory_kb/1024 AS [Available Memory (MB)],
total_page_file_kb/1024 AS [Total Page File (MB)],
available_page_file_kb/1024 AS [Available Page File (MB)],
system_cache_kb/1024 AS [System Cache (MB)],
system_memory_state_desc AS [System Memory State]
FROM sys.dm_os_sys_memory WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You want to see "Available physical memory is high" for System Memory State
-- This indicates that you are not under external memory pressure
-- Possible System Memory State values:
-- Available physical memory is high
-- Physical memory usage is steady
-- Available physical memory is low
-- Available physical memory is running low
-- Physical memory state is transitioning
-- sys.dm_os_sys_memory (Transact-SQL)
-- https://bit.ly/2pcV0xq
-- You can skip the next two queries if you know you don't have a clustered instance
-- Get information about your cluster nodes and their status (Query 15) (Cluster Node Properties)
-- (if your database server is in a failover cluster)
SELECT NodeName, status_description, is_current_owner
FROM sys.dm_os_cluster_nodes WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Knowing which node owns the cluster resources is critical
-- Especially when you are installing Windows or SQL Server updates
-- You will see no results if your instance is not clustered
-- Recommended hotfixes and updates for Windows Server 2012 R2-based failover clusters
-- https://bit.ly/1z5BfCw
-- Get information about any AlwaysOn AG cluster this instance is a part of (Query 16) (AlwaysOn AG Cluster)
SELECT cluster_name, quorum_type_desc, quorum_state_desc
FROM sys.dm_hadr_cluster WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You will see no results if your instance is not using AlwaysOn AGs
-- Good overview of AG health and status (Query 17) (AlwaysOn AG Status)
SELECT ag.name AS [AG Name], ar.replica_server_name, ar.availability_mode_desc, adc.[database_name],
drs.is_local, drs.is_primary_replica, drs.synchronization_state_desc, drs.is_commit_participant,
drs.synchronization_health_desc, drs.recovery_lsn, drs.truncation_lsn, drs.last_sent_lsn,
drs.last_sent_time, drs.last_received_lsn, drs.last_received_time, drs.last_hardened_lsn,
drs.last_hardened_time, drs.last_redone_lsn, drs.last_redone_time, drs.log_send_queue_size,
drs.log_send_rate, drs.redo_queue_size, drs.redo_rate, drs.filestream_send_rate,
drs.end_of_log_lsn, drs.last_commit_lsn, drs.last_commit_time, drs.database_state_desc
FROM sys.dm_hadr_database_replica_states AS drs WITH (NOLOCK)
INNER JOIN sys.availability_databases_cluster AS adc WITH (NOLOCK)
ON drs.group_id = adc.group_id
AND drs.group_database_id = adc.group_database_id
INNER JOIN sys.availability_groups AS ag WITH (NOLOCK)
ON ag.group_id = drs.group_id
INNER JOIN sys.availability_replicas AS ar WITH (NOLOCK)
ON drs.group_id = ar.group_id
AND drs.replica_id = ar.replica_id
ORDER BY ag.name, ar.replica_server_name, adc.[database_name] OPTION (RECOMPILE);
-- You will see no results if your instance is not using AlwaysOn AGs
-- SQL Server 2016 � It Just Runs Faster: Always On Availability Groups Turbocharged
-- https://bit.ly/2dn1H6r
-- Hardware information from SQL Server 2017 (Query 18) (Hardware Info)
SELECT cpu_count AS [Logical CPU Count], scheduler_count,
(socket_count * cores_per_socket) AS [Physical Core Count],
socket_count AS [Socket Count], cores_per_socket, numa_node_count,
physical_memory_kb/1024 AS [Physical Memory (MB)],
max_workers_count AS [Max Workers Count],
affinity_type_desc AS [Affinity Type],
sqlserver_start_time AS [SQL Server Start Time],
virtual_machine_type_desc AS [Virtual Machine Type],
softnuma_configuration_desc AS [Soft NUMA Configuration],
sql_memory_model_desc, process_physical_affinity -- New in SQL Server 2017
FROM sys.dm_os_sys_info WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Gives you some good basic hardware information about your database server
-- Note: virtual_machine_type_desc of HYPERVISOR does not automatically mean you are running SQL Server inside of a VM
-- It merely indicates that you have a hypervisor running on your host
-- sys.dm_os_sys_info (Transact-SQL)
-- https://bit.ly/2pczOYs
-- Soft NUMA configuration was a new column for SQL Server 2016
-- OFF = Soft-NUMA feature is OFF
-- ON = SQL Server automatically determines the NUMA node sizes for Soft-NUMA
-- MANUAL = Manually configured soft-NUMA
-- Configure SQL Server to Use Soft-NUMA (SQL Server)
-- https://bit.ly/2HTpKJt
-- sql_memory_model_desc values (Added in SQL Server 2016 SP1)
-- CONVENTIONAL
-- LOCK_PAGES
-- LARGE_PAGES
-- Get System Manufacturer and model number from SQL Server Error log (Query 19) (System Manufacturer)
EXEC sys.xp_readerrorlog 0, 1, N'Manufacturer';
------
-- This can help you determine the capabilities and capacities of your database server
-- Can also be used to confirm if you are running in a VM
-- This query might take a few seconds if you have not recycled your error log recently
-- This query will return no results if your error log has been recycled since the instance was started
-- Get BIOS date from Windows Registry (Query 20) (BIOS Date)
EXEC sys.xp_instance_regread N'HKEY_LOCAL_MACHINE', N'HARDWARE\DESCRIPTION\System\BIOS', N'BiosReleaseDate';
------
-- Helps you understand whether the main system BIOS is up to date, and the possible age of the hardware
-- Not as useful for virtualization
-- Get processor description from Windows Registry (Query 21) (Processor Description)
EXEC sys.xp_instance_regread N'HKEY_LOCAL_MACHINE', N'HARDWARE\DESCRIPTION\System\CentralProcessor\0', N'ProcessorNameString';
------
-- Gives you the model number and rated clock speed of your processor(s)
-- Your processors may be running at less than the rated clock speed due
-- to the Windows Power Plan or hardware power management
-- You can use CPU-Z to get your actual CPU core speed and a lot of other useful information
-- https://bit.ly/QhR6xF
-- You can learn more about processor selection for SQL Server by following this link
-- https://bit.ly/2F3aVlP
-- See if buffer pool extension (BPE) is enabled (Query 22) (BPE Configuration)
SELECT [path], state_description, current_size_in_kb,
CAST(current_size_in_kb/1048576.0 AS DECIMAL(10,2)) AS [Size (GB)]
FROM sys.dm_os_buffer_pool_extension_configuration WITH (NOLOCK) OPTION (RECOMPILE);
------
-- BPE is available in both Standard Edition and Enterprise Edition
-- It is a more interesting feature for Standard Edition
-- Buffer Pool Extension to SSDs in SQL Server 2014
-- https://bit.ly/1bm08m8
-- Buffer Pool Extension
-- https://bit.ly/2oBuieO
-- Look at buffer descriptors to see BPE usage by database (Query 23) (BPE Usage)
SELECT DB_NAME(database_id) AS [Database Name], COUNT(page_id) AS [Page Count],
CAST(COUNT(*)/128.0 AS DECIMAL(10, 2)) AS [Buffer size(MB)],
AVG(read_microsec) AS [Avg Read Time (microseconds)]
FROM sys.dm_os_buffer_descriptors WITH (NOLOCK)
WHERE database_id <> 32767
AND is_in_bpool_extension = 1
GROUP BY DB_NAME(database_id)
ORDER BY [Buffer size(MB)] DESC OPTION (RECOMPILE);
------
-- You will see no results if BPE is not enabled or if there is no BPE usage
-- Get information on location, time and size of any memory dumps from SQL Server (Query 24) (Memory Dump Info)
SELECT [filename], creation_time, size_in_bytes/1048576.0 AS [Size (MB)]
FROM sys.dm_server_memory_dumps WITH (NOLOCK)
ORDER BY creation_time DESC OPTION (RECOMPILE);
------
-- This will not return any rows if you have
-- not had any memory dumps (which is a good thing)
-- sys.dm_server_memory_dumps (Transact-SQL)
-- https://bit.ly/2elwWll
-- Look at Suspect Pages table (Query 25) (Suspect Pages)
SELECT DB_NAME(database_id) AS [Database Name], [file_id], page_id,
event_type, error_count, last_update_date
FROM msdb.dbo.suspect_pages WITH (NOLOCK)
ORDER BY database_id OPTION (RECOMPILE);
------
-- event_type value descriptions
-- 1 = 823 error caused by an operating system CRC error
-- or 824 error other than a bad checksum or a torn page (for example, a bad page ID)
-- 2 = Bad checksum
-- 3 = Torn page
-- 4 = Restored (The page was restored after it was marked bad)
-- 5 = Repaired (DBCC repaired the page)
-- 7 = Deallocated by DBCC
-- Ideally, this query returns no results. The table is limited to 1000 rows.
-- If you do get results here, you should do further investigation to determine the root cause
-- Manage the suspect_pages Table
-- https://bit.ly/2Fvr1c9
-- Get number of data files in tempdb database (Query 26) (TempDB Data Files)
EXEC sys.xp_readerrorlog 0, 1, N'The tempdb database has';
------
-- Get the number of data files in the tempdb database
-- 4-8 data files that are all the same size is a good starting point
-- This query will return no results if your error log has been recycled since the instance was last started
-- File names and paths for all user and system databases on instance (Query 27) (Database Filenames and Paths)
SELECT DB_NAME([database_id]) AS [Database Name],
[file_id], [name], physical_name, [type_desc], state_desc,
is_percent_growth, growth,
CONVERT(bigint, growth/128.0) AS [Growth in MB],
CONVERT(bigint, size/128.0) AS [Total Size in MB]
FROM sys.master_files WITH (NOLOCK)
ORDER BY DB_NAME([database_id]), [file_id] OPTION (RECOMPILE);
------
-- Things to look at:
-- Are data files and log files on different drives?
-- Is everything on the C: drive?
-- Is tempdb on dedicated drives?
-- Is there only one tempdb data file?
-- Are all of the tempdb data files the same size?
-- Are there multiple data files for user databases?
-- Is percent growth enabled for any files (which is bad)?
-- Drive information for all fixed drives visible to the operating system (Query 28) (Fixed Drives)
SELECT fixed_drive_path, drive_type_desc,
CONVERT(DECIMAL(18,2), free_space_in_bytes/1073741824.0) AS [Available Space (GB)]
FROM sys.dm_os_enumerate_fixed_drives WITH (NOLOCK) OPTION (RECOMPILE);
------
-- This shows all of your fixed drives, not just LUNs with SQL Server database files
-- Volume info for all LUNS that have database files on the current instance (Query 29) (Volume Info)
SELECT DISTINCT vs.volume_mount_point, vs.file_system_type, vs.logical_volume_name,
CONVERT(DECIMAL(18,2), vs.total_bytes/1073741824.0) AS [Total Size (GB)],
CONVERT(DECIMAL(18,2), vs.available_bytes/1073741824.0) AS [Available Size (GB)],
CONVERT(DECIMAL(18,2), vs.available_bytes * 1. / vs.total_bytes * 100.) AS [Space Free %],
vs.supports_compression, vs.is_compressed,
vs.supports_sparse_files, vs.supports_alternate_streams
FROM sys.master_files AS f WITH (NOLOCK)
CROSS APPLY sys.dm_os_volume_stats(f.database_id, f.[file_id]) AS vs
ORDER BY vs.volume_mount_point OPTION (RECOMPILE);
------
-- Shows you the total and free space on the LUNs where you have database files
-- Being low on free space can negatively affect performance
-- sys.dm_os_volume_stats (Transact-SQL)
-- https://bit.ly/2oBPNNr
-- Drive level latency information (Query 30) (Drive Level Latency)
-- Based on code from Jimmy May
SELECT tab.[Drive], tab.volume_mount_point AS [Volume Mount Point],
CASE
WHEN num_of_reads = 0 THEN 0
ELSE (io_stall_read_ms/num_of_reads)
END AS [Read Latency],
CASE
WHEN num_of_writes = 0 THEN 0
ELSE (io_stall_write_ms/num_of_writes)
END AS [Write Latency],
CASE
WHEN (num_of_reads = 0 AND num_of_writes = 0) THEN 0
ELSE (io_stall/(num_of_reads + num_of_writes))
END AS [Overall Latency],
CASE
WHEN num_of_reads = 0 THEN 0
ELSE (num_of_bytes_read/num_of_reads)
END AS [Avg Bytes/Read],
CASE
WHEN num_of_writes = 0 THEN 0
ELSE (num_of_bytes_written/num_of_writes)
END AS [Avg Bytes/Write],
CASE
WHEN (num_of_reads = 0 AND num_of_writes = 0) THEN 0
ELSE ((num_of_bytes_read + num_of_bytes_written)/(num_of_reads + num_of_writes))
END AS [Avg Bytes/Transfer]
FROM (SELECT LEFT(UPPER(mf.physical_name), 2) AS Drive, SUM(num_of_reads) AS num_of_reads,
SUM(io_stall_read_ms) AS io_stall_read_ms, SUM(num_of_writes) AS num_of_writes,
SUM(io_stall_write_ms) AS io_stall_write_ms, SUM(num_of_bytes_read) AS num_of_bytes_read,
SUM(num_of_bytes_written) AS num_of_bytes_written, SUM(io_stall) AS io_stall, vs.volume_mount_point
FROM sys.dm_io_virtual_file_stats(NULL, NULL) AS vfs
INNER JOIN sys.master_files AS mf WITH (NOLOCK)
ON vfs.database_id = mf.database_id AND vfs.file_id = mf.file_id
CROSS APPLY sys.dm_os_volume_stats(mf.database_id, mf.[file_id]) AS vs
GROUP BY LEFT(UPPER(mf.physical_name), 2), vs.volume_mount_point) AS tab
ORDER BY [Overall Latency] OPTION (RECOMPILE);
------
-- Shows you the drive-level latency for reads and writes, in milliseconds
-- Latency above 30-40ms is usually a problem
-- These latency numbers include all file activity against all SQL Server
-- database files on each drive since SQL Server was last started
-- Calculates average stalls per read, per write, and per total input/output for each database file (Query 31) (IO Stalls by File)
SELECT DB_NAME(fs.database_id) AS [Database Name], CAST(fs.io_stall_read_ms/(1.0 + fs.num_of_reads) AS NUMERIC(10,1)) AS [avg_read_stall_ms],
CAST(fs.io_stall_write_ms/(1.0 + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_write_stall_ms],
CAST((fs.io_stall_read_ms + fs.io_stall_write_ms)/(1.0 + fs.num_of_reads + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_io_stall_ms],
CONVERT(DECIMAL(18,2), mf.size/128.0) AS [File Size (MB)], mf.physical_name, mf.type_desc, fs.io_stall_read_ms, fs.num_of_reads,
fs.io_stall_write_ms, fs.num_of_writes, fs.io_stall_read_ms + fs.io_stall_write_ms AS [io_stalls], fs.num_of_reads + fs.num_of_writes AS [total_io],
io_stall_queued_read_ms AS [Resource Governor Total Read IO Latency (ms)], io_stall_queued_write_ms AS [Resource Governor Total Write IO Latency (ms)]
FROM sys.dm_io_virtual_file_stats(null,null) AS fs
INNER JOIN sys.master_files AS mf WITH (NOLOCK)
ON fs.database_id = mf.database_id
AND fs.[file_id] = mf.[file_id]
ORDER BY avg_io_stall_ms DESC OPTION (RECOMPILE);
------
-- Helps determine which database files on the entire instance have the most I/O bottlenecks
-- This can help you decide whether certain LUNs are overloaded and whether you might
-- want to move some files to a different location or perhaps improve your I/O performance
-- These latency numbers include all file activity against each SQL Server
-- database file since SQL Server was last started
-- Look for I/O requests taking longer than 15 seconds in the six most recent SQL Server Error Logs (Query 32) (IO Warnings)
CREATE TABLE #IOWarningResults(LogDate datetime, ProcessInfo sysname, LogText nvarchar(1000));
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 0, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 1, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 2, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 3, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 4, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 5, 1, N'taking longer than 15 seconds';
SELECT LogDate, ProcessInfo, LogText
FROM #IOWarningResults
ORDER BY LogDate DESC;
DROP TABLE #IOWarningResults;
------
-- Finding 15 second I/O warnings in the SQL Server Error Log is useful evidence of
-- poor I/O performance (which might have many different causes)
-- Look to see if you see any patterns in the results (same files, same drives, same time of day, etc.)
-- Diagnostics in SQL Server help detect stalled and stuck I/O operations
-- https://bit.ly/2qtaw73
-- Recovery model, log reuse wait description, log file size, log usage size (Query 33) (Database Properties)
-- and compatibility level for all databases on instance
SELECT db.[name] AS [Database Name], SUSER_SNAME(db.owner_sid) AS [Database Owner], db.recovery_model_desc AS [Recovery Model],
db.state_desc, db.containment_desc, db.log_reuse_wait_desc AS [Log Reuse Wait Description],
CONVERT(DECIMAL(18,2), ls.cntr_value/1024.0) AS [Log Size (MB)], CONVERT(DECIMAL(18,2), lu.cntr_value/1024.0) AS [Log Used (MB)],
CAST(CAST(lu.cntr_value AS FLOAT) / CAST(ls.cntr_value AS FLOAT)AS DECIMAL(18,2)) * 100 AS [Log Used %],
db.[compatibility_level] AS [DB Compatibility Level],
db.is_mixed_page_allocation_on, db.page_verify_option_desc AS [Page Verify Option],
db.is_auto_create_stats_on, db.is_auto_update_stats_on, db.is_auto_update_stats_async_on, db.is_parameterization_forced,
db.snapshot_isolation_state_desc, db.is_read_committed_snapshot_on, db.is_auto_close_on, db.is_auto_shrink_on,
db.target_recovery_time_in_seconds, db.is_cdc_enabled, db.is_published, db.is_distributor,
db.group_database_id, db.replica_id,db.is_memory_optimized_elevate_to_snapshot_on,
db.delayed_durability_desc, db.is_auto_create_stats_incremental_on,
db.is_query_store_on, db.is_sync_with_backup, db.is_temporal_history_retention_enabled,
db.is_supplemental_logging_enabled, db.is_remote_data_archive_enabled,
db.is_encrypted, de.encryption_state, de.percent_complete, de.key_algorithm, de.key_length
FROM sys.databases AS db WITH (NOLOCK)
INNER JOIN sys.dm_os_performance_counters AS lu WITH (NOLOCK)
ON db.name = lu.instance_name
INNER JOIN sys.dm_os_performance_counters AS ls WITH (NOLOCK)
ON db.name = ls.instance_name
LEFT OUTER JOIN sys.dm_database_encryption_keys AS de WITH (NOLOCK)
ON db.database_id = de.database_id
WHERE lu.counter_name LIKE N'Log File(s) Used Size (KB)%'
AND ls.counter_name LIKE N'Log File(s) Size (KB)%'
AND ls.cntr_value > 0
ORDER BY db.[name] OPTION (RECOMPILE);
------
-- Things to look at:
-- How many databases are on the instance?
-- What recovery models are they using?
-- What is the log reuse wait description?
-- How full are the transaction logs?
-- What compatibility level are the databases on?
-- What is the Page Verify Option? (should be CHECKSUM)
-- Is Auto Update Statistics Asynchronously enabled?
-- Is Delayed Durability enabled
-- Make sure auto_shrink and auto_close are not enabled!
-- is_mixed_page_allocation_on is a new property for SQL Server 2016. Equivalent to TF 1118 for a user database
-- SQL Server 2016: Changes in default behavior for autogrow and allocations for tempdb and user databases
-- https://bit.ly/2evRZSR
-- A non-zero value for target_recovery_time_in_seconds means that indirect checkpoint is enabled
-- If the setting has a zero value it indicates that automatic checkpoint is enabled
-- Changes in SQL Server 2016 Checkpoint Behavior
-- https://bit.ly/2pdggk3
-- Missing Indexes for all databases by Index Advantage (Query 34) (Missing Indexes All Databases)
SELECT CONVERT(decimal(18,2), user_seeks * avg_total_user_cost * (avg_user_impact * 0.01)) AS [index_advantage],
FORMAT(migs.last_user_seek, 'yyyy-MM-dd HH:mm:ss') AS [last_user_seek],
mid.[statement] AS [Database.Schema.Table],
COUNT(1) OVER(PARTITION BY mid.[statement]) AS [missing_indexes_for_table],
COUNT(1) OVER(PARTITION BY mid.[statement], equality_columns) AS [similar_missing_indexes_for_table],
mid.equality_columns, mid.inequality_columns, mid.included_columns,
migs.unique_compiles, migs.user_seeks,
CONVERT(decimal(18,2), migs.avg_total_user_cost) AS [avg_total_user_cost], migs.avg_user_impact
FROM sys.dm_db_missing_index_group_stats AS migs WITH (NOLOCK)
INNER JOIN sys.dm_db_missing_index_groups AS mig WITH (NOLOCK)
ON migs.group_handle = mig.index_group_handle
INNER JOIN sys.dm_db_missing_index_details AS mid WITH (NOLOCK)
ON mig.index_handle = mid.index_handle
ORDER BY index_advantage DESC OPTION (RECOMPILE);
------
-- Getting missing index information for all of the databases on the instance is very useful
-- Look at last user seek time, number of user seeks to help determine source and importance
-- Also look at avg_user_impact and avg_total_user_cost to help determine importance
-- SQL Server is overly eager to add included columns, so beware
-- Do not just blindly add indexes that show up from this query!!!
-- SQL Server Index Design Guide
-- https://bit.ly/2qtZr4N
-- Get VLF Counts for all databases on the instance (Query 35) (VLF Counts)
SELECT�[name] AS [Database Name],�[VLF Count]
FROM�sys.databases�AS db WITH (NOLOCK)
CROSS APPLY�(SELECT�file_id, COUNT(*)�AS [VLF Count]�
FROM sys.dm_db_log_info(db.database_id)
���������� GROUP BY�file_id)�AS li
ORDER BY [VLF Count] DESC OPTION (RECOMPILE);
------
-- High VLF counts can affect write performance to the log file
-- and they can make full database restores and crash recovery take much longer
-- Try to keep your VLF counts under 200 in most cases (depending on log file size)
-- Important change to VLF creation algorithm in SQL Server 2014
-- https://bit.ly/2Hsjbg4
-- SQL Server Transaction Log Architecture and Management Guide
-- https://bit.ly/2JjmQRZ
-- Get CPU utilization by database (Query 36) (CPU Usage by Database)
WITH DB_CPU_Stats
AS
(SELECT pa.DatabaseID, DB_Name(pa.DatabaseID) AS [Database Name], SUM(qs.total_worker_time/1000) AS [CPU_Time_Ms]
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY (SELECT CONVERT(int, value) AS [DatabaseID]
FROM sys.dm_exec_plan_attributes(qs.plan_handle)
WHERE attribute = N'dbid') AS pa
GROUP BY DatabaseID)
SELECT ROW_NUMBER() OVER(ORDER BY [CPU_Time_Ms] DESC) AS [CPU Rank],
[Database Name], [CPU_Time_Ms] AS [CPU Time (ms)],
CAST([CPU_Time_Ms] * 1.0 / SUM([CPU_Time_Ms]) OVER() * 100.0 AS DECIMAL(5, 2)) AS [CPU Percent]
FROM DB_CPU_Stats
WHERE DatabaseID <> 32767 -- ResourceDB
ORDER BY [CPU Rank] OPTION (RECOMPILE);
------
-- Helps determine which database is using the most CPU resources on the instance
-- Get I/O utilization by database (Query 37) (IO Usage By Database)
WITH Aggregate_IO_Statistics
AS (SELECT DB_NAME(database_id) AS [Database Name],
CAST(SUM(num_of_bytes_read + num_of_bytes_written) / 1048576 AS DECIMAL(12, 2)) AS [ioTotalMB],
CAST(SUM(num_of_bytes_read ) / 1048576 AS DECIMAL(12, 2)) AS [ioReadMB],
CAST(SUM(num_of_bytes_written) / 1048576 AS DECIMAL(12, 2)) AS [ioWriteMB]
FROM sys.dm_io_virtual_file_stats(NULL, NULL) AS [DM_IO_STATS]
GROUP BY database_id)
SELECT ROW_NUMBER() OVER (ORDER BY ioTotalMB DESC) AS [I/O Rank],
[Database Name], ioTotalMB AS [Total I/O (MB)],
CAST(ioTotalMB / SUM(ioTotalMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Total I/O %],
ioReadMB AS [Read I/O (MB)],
CAST(ioReadMB / SUM(ioReadMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Read I/O %],
ioWriteMB AS [Write I/O (MB)],
CAST(ioWriteMB / SUM(ioWriteMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Write I/O %]
FROM Aggregate_IO_Statistics
ORDER BY [I/O Rank] OPTION (RECOMPILE);
------
-- Helps determine which database is using the most I/O resources on the instance
-- These numbers are cumulative since the last service restart
-- They include all I/O activity, not just the nominal I/O workload
-- Get total buffer usage by database for current instance (Query 38) (Total Buffer Usage by Database)
-- This make take some time to run on a busy instance
WITH AggregateBufferPoolUsage
AS
(SELECT DB_NAME(database_id) AS [Database Name],
CAST(COUNT(*) * 8/1024.0 AS DECIMAL (10,2)) AS [CachedSize]
FROM sys.dm_os_buffer_descriptors WITH (NOLOCK)
WHERE database_id <> 32767 -- ResourceDB
GROUP BY DB_NAME(database_id))
SELECT ROW_NUMBER() OVER(ORDER BY CachedSize DESC) AS [Buffer Pool Rank], [Database Name], CachedSize AS [Cached Size (MB)],
CAST(CachedSize / SUM(CachedSize) OVER() * 100.0 AS DECIMAL(5,2)) AS [Buffer Pool Percent]
FROM AggregateBufferPoolUsage
ORDER BY [Buffer Pool Rank] OPTION (RECOMPILE);
------
-- Tells you how much memory (in the buffer pool)
-- is being used by each database on the instance
-- Get tempdb version store space usage by database (Query 39) (Version Store Space Usage)
SELECT DB_NAME(database_id) AS [Database Name],
reserved_page_count AS [Version Store Reserved Page Count],
reserved_space_kb/1024 AS [Version Store Reserved Space (MB)]
FROM sys.dm_tran_version_store_space_usage WITH (NOLOCK)
ORDER BY reserved_space_kb/1024 DESC OPTION (RECOMPILE);
------
-- sys.dm_tran_version_store_space_usage (Transact-SQL)
-- https://bit.ly/2vh3Bmk
-- Clear Wait Stats with this command
-- DBCC SQLPERF('sys.dm_os_wait_stats', CLEAR);
-- Isolate top waits for server instance since last restart or wait statistics clear (Query 40) (Top Waits)
WITH [Waits]
AS (SELECT wait_type, wait_time_ms/ 1000.0 AS [WaitS],
(wait_time_ms - signal_wait_time_ms) / 1000.0 AS [ResourceS],
signal_wait_time_ms / 1000.0 AS [SignalS],
waiting_tasks_count AS [WaitCount],
100.0 * wait_time_ms / SUM (wait_time_ms) OVER() AS [Percentage],
ROW_NUMBER() OVER(ORDER BY wait_time_ms DESC) AS [RowNum]
FROM sys.dm_os_wait_stats WITH (NOLOCK)
WHERE [wait_type] NOT IN (
N'BROKER_EVENTHANDLER', N'BROKER_RECEIVE_WAITFOR', N'BROKER_TASK_STOP',
N'BROKER_TO_FLUSH', N'BROKER_TRANSMITTER', N'CHECKPOINT_QUEUE',
N'CHKPT', N'CLR_AUTO_EVENT', N'CLR_MANUAL_EVENT', N'CLR_SEMAPHORE', N'CXCONSUMER',
N'DBMIRROR_DBM_EVENT', N'DBMIRROR_EVENTS_QUEUE', N'DBMIRROR_WORKER_QUEUE',
N'DBMIRRORING_CMD', N'DIRTY_PAGE_POLL', N'DISPATCHER_QUEUE_SEMAPHORE',
N'EXECSYNC', N'FSAGENT', N'FT_IFTS_SCHEDULER_IDLE_WAIT', N'FT_IFTSHC_MUTEX',
N'HADR_CLUSAPI_CALL', N'HADR_FILESTREAM_IOMGR_IOCOMPLETION', N'HADR_LOGCAPTURE_WAIT',
N'HADR_NOTIFICATION_DEQUEUE', N'HADR_TIMER_TASK', N'HADR_WORK_QUEUE',
N'KSOURCE_WAKEUP', N'LAZYWRITER_SLEEP', N'LOGMGR_QUEUE',
N'MEMORY_ALLOCATION_EXT', N'ONDEMAND_TASK_QUEUE',
N'PARALLEL_REDO_DRAIN_WORKER', N'PARALLEL_REDO_LOG_CACHE', N'PARALLEL_REDO_TRAN_LIST',
N'PARALLEL_REDO_WORKER_SYNC', N'PARALLEL_REDO_WORKER_WAIT_WORK',
N'PREEMPTIVE_HADR_LEASE_MECHANISM', N'PREEMPTIVE_SP_SERVER_DIAGNOSTICS',
N'PREEMPTIVE_OS_LIBRARYOPS', N'PREEMPTIVE_OS_COMOPS', N'PREEMPTIVE_OS_CRYPTOPS',
N'PREEMPTIVE_OS_PIPEOPS', N'PREEMPTIVE_OS_AUTHENTICATIONOPS',
N'PREEMPTIVE_OS_GENERICOPS', N'PREEMPTIVE_OS_VERIFYTRUST',
N'PREEMPTIVE_OS_FILEOPS', N'PREEMPTIVE_OS_DEVICEOPS', N'PREEMPTIVE_OS_QUERYREGISTRY',
N'PREEMPTIVE_OS_WRITEFILE',
N'PREEMPTIVE_XE_CALLBACKEXECUTE', N'PREEMPTIVE_XE_DISPATCHER',
N'PREEMPTIVE_XE_GETTARGETSTATE', N'PREEMPTIVE_XE_SESSIONCOMMIT',
N'PREEMPTIVE_XE_TARGETINIT', N'PREEMPTIVE_XE_TARGETFINALIZE',
N'PWAIT_ALL_COMPONENTS_INITIALIZED', N'PWAIT_DIRECTLOGCONSUMER_GETNEXT',
N'QDS_PERSIST_TASK_MAIN_LOOP_SLEEP',
N'QDS_ASYNC_QUEUE',
N'QDS_CLEANUP_STALE_QUERIES_TASK_MAIN_LOOP_SLEEP', N'REQUEST_FOR_DEADLOCK_SEARCH',
N'RESOURCE_QUEUE', N'SERVER_IDLE_CHECK', N'SLEEP_BPOOL_FLUSH', N'SLEEP_DBSTARTUP',
N'SLEEP_DCOMSTARTUP', N'SLEEP_MASTERDBREADY', N'SLEEP_MASTERMDREADY',
N'SLEEP_MASTERUPGRADED', N'SLEEP_MSDBSTARTUP', N'SLEEP_SYSTEMTASK', N'SLEEP_TASK',
N'SLEEP_TEMPDBSTARTUP', N'SNI_HTTP_ACCEPT', N'SP_SERVER_DIAGNOSTICS_SLEEP',
N'SQLTRACE_BUFFER_FLUSH', N'SQLTRACE_INCREMENTAL_FLUSH_SLEEP', N'SQLTRACE_WAIT_ENTRIES',
N'WAIT_FOR_RESULTS', N'WAITFOR', N'WAITFOR_TASKSHUTDOWN', N'WAIT_XTP_HOST_WAIT',
N'WAIT_XTP_OFFLINE_CKPT_NEW_LOG', N'WAIT_XTP_CKPT_CLOSE', N'WAIT_XTP_RECOVERY',
N'XE_BUFFERMGR_ALLPROCESSED_EVENT', N'XE_DISPATCHER_JOIN',
N'XE_DISPATCHER_WAIT', N'XE_LIVE_TARGET_TVF', N'XE_TIMER_EVENT')
AND waiting_tasks_count > 0)
SELECT
MAX (W1.wait_type) AS [WaitType],
CAST (MAX (W1.Percentage) AS DECIMAL (5,2)) AS [Wait Percentage],
CAST ((MAX (W1.WaitS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgWait_Sec],
CAST ((MAX (W1.ResourceS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgRes_Sec],
CAST ((MAX (W1.SignalS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgSig_Sec],
CAST (MAX (W1.WaitS) AS DECIMAL (16,2)) AS [Wait_Sec],
CAST (MAX (W1.ResourceS) AS DECIMAL (16,2)) AS [Resource_Sec],
CAST (MAX (W1.SignalS) AS DECIMAL (16,2)) AS [Signal_Sec],
MAX (W1.WaitCount) AS [Wait Count],
CAST (N'https://www.sqlskills.com/help/waits/' + W1.wait_type AS XML) AS [Help/Info URL]
FROM Waits AS W1
INNER JOIN Waits AS W2
ON W2.RowNum <= W1.RowNum
GROUP BY W1.RowNum, W1.wait_type
HAVING SUM (W2.Percentage) - MAX (W1.Percentage) < 99 -- percentage threshold
OPTION (RECOMPILE);
------
-- Cumulative wait stats are not as useful on an idle instance that is not under load or performance pressure
-- SQL Server Wait Types Library (Paul Randal)
-- https://bit.ly/2ePzYO2
-- The SQL Server Wait Type Repository
-- https://bit.ly/1afzfjC
-- Wait statistics, or please tell me where it hurts
-- https://bit.ly/2wsQHQE
-- SQL Server 2005 Performance Tuning using the Waits and Queues
-- https://bit.ly/1o2NFoF
-- sys.dm_os_wait_stats (Transact-SQL)
-- https://bit.ly/2Hjq9Yl
-- Get a count of SQL connections by IP address (Query 41) (Connection Counts by IP Address)
SELECT ec.client_net_address, es.[program_name], es.[host_name], es.login_name,
COUNT(ec.session_id) AS [connection count]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
INNER JOIN sys.dm_exec_connections AS ec WITH (NOLOCK)
ON es.session_id = ec.session_id
GROUP BY ec.client_net_address, es.[program_name], es.[host_name], es.login_name
ORDER BY ec.client_net_address, es.[program_name] OPTION (RECOMPILE);
------
-- This helps you figure where your database load is coming from
-- and verifies connectivity from other machines
-- Solving Connectivity errors to SQL Server
-- https://bit.ly/2EgzoD0
-- Get Average Task Counts (run multiple times) (Query 42) (Avg Task Counts)
SELECT AVG(current_tasks_count) AS [Avg Task Count],
AVG(work_queue_count) AS [Avg Work Queue Count],
AVG(runnable_tasks_count) AS [Avg Runnable Task Count],
AVG(pending_disk_io_count) AS [Avg Pending DiskIO Count]
FROM sys.dm_os_schedulers WITH (NOLOCK)
WHERE scheduler_id < 255 OPTION (RECOMPILE);
------
-- Sustained values above 10 suggest further investigation in that area
-- High Avg Task Counts are often caused by blocking/deadlocking or other resource contention
-- Sustained values above 1 suggest further investigation in that area
-- High Avg Runnable Task Counts are a good sign of CPU pressure
-- High Avg Pending DiskIO Counts are a sign of disk pressure
-- How to Do Some Very Basic SQL Server Monitoring
-- https://bit.ly/2q3Btgt
-- Detect blocking (run multiple times) (Query 43) (Detect Blocking)
SELECT t1.resource_type AS [lock type], DB_NAME(resource_database_id) AS [database],
t1.resource_associated_entity_id AS [blk object],t1.request_mode AS [lock req], -- lock requested
t1.request_session_id AS [waiter sid], t2.wait_duration_ms AS [wait time], -- spid of waiter
(SELECT [text] FROM sys.dm_exec_requests AS r WITH (NOLOCK) -- get sql for waiter
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle])
WHERE r.session_id = t1.request_session_id) AS [waiter_batch],
(SELECT SUBSTRING(qt.[text],r.statement_start_offset/2,
(CASE WHEN r.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE r.statement_end_offset END - r.statement_start_offset)/2)
FROM sys.dm_exec_requests AS r WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle]) AS qt
WHERE r.session_id = t1.request_session_id) AS [waiter_stmt], -- statement blocked
t2.blocking_session_id AS [blocker sid], -- spid of blocker
(SELECT [text] FROM sys.sysprocesses AS p -- get sql for blocker
CROSS APPLY sys.dm_exec_sql_text(p.[sql_handle])
WHERE p.spid = t2.blocking_session_id) AS [blocker_batch]
FROM sys.dm_tran_locks AS t1 WITH (NOLOCK)
INNER JOIN sys.dm_os_waiting_tasks AS t2 WITH (NOLOCK)
ON t1.lock_owner_address = t2.resource_address OPTION (RECOMPILE);
------
-- Helps troubleshoot blocking and deadlocking issues
-- The results will change from second to second on a busy system
-- You should run this query multiple times when you see signs of blocking
-- Get CPU Utilization History for last 256 minutes (in one minute intervals) (Query 44) (CPU Utilization History)
DECLARE @ts_now bigint = (SELECT cpu_ticks/(cpu_ticks/ms_ticks) FROM sys.dm_os_sys_info WITH (NOLOCK));
SELECT TOP(256) SQLProcessUtilization AS [SQL Server Process CPU Utilization],
SystemIdle AS [System Idle Process],
100 - SystemIdle - SQLProcessUtilization AS [Other Process CPU Utilization],
DATEADD(ms, -1 * (@ts_now - [timestamp]), GETDATE()) AS [Event Time]
FROM (SELECT record.value('(./Record/@id)[1]', 'int') AS record_id,
record.value('(./Record/SchedulerMonitorEvent/SystemHealth/SystemIdle)[1]', 'int')
AS [SystemIdle],
record.value('(./Record/SchedulerMonitorEvent/SystemHealth/ProcessUtilization)[1]', 'int')
AS [SQLProcessUtilization], [timestamp]
FROM (SELECT [timestamp], CONVERT(xml, record) AS [record]
FROM sys.dm_os_ring_buffers WITH (NOLOCK)
WHERE ring_buffer_type = N'RING_BUFFER_SCHEDULER_MONITOR'
AND record LIKE N'%<SystemHealth>%') AS x) AS y
ORDER BY record_id DESC OPTION (RECOMPILE);
------
-- Look at the trend over the entire period
-- Also look at high sustained 'Other Process' CPU Utilization values
-- Note: This query sometimes gives inaccurate results (negative values)
-- on high core count (> 64 cores) systems
-- Get top total worker time queries for entire instance (Query 45) (Top Worker Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_worker_time AS [Total Worker Time], qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a CPU perspective across the entire instance
-- Can also help track down parameter sniffing issues
-- Page Life Expectancy (PLE) value for each NUMA node in current instance (Query 46) (PLE by NUMA Node)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], instance_name, cntr_value AS [Page Life Expectancy]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Buffer Node%' -- Handles named instances
AND counter_name = N'Page life expectancy' OPTION (RECOMPILE);
------
-- PLE is a good measurement of internal memory pressure
-- Higher PLE is better. Watch the trend over time, not the absolute value
-- This will only return one row for non-NUMA systems
-- Page Life Expectancy isn�t what you think�
-- https://bit.ly/2EgynLa
-- Memory Grants Pending value for current instance (Query 47) (Memory Grants Pending)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], cntr_value AS [Memory Grants Pending]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Memory Manager%' -- Handles named instances
AND counter_name = N'Memory Grants Pending' OPTION (RECOMPILE);
------
-- Run multiple times, and run periodically if you suspect you are under memory pressure
-- Memory Grants Pending above zero for a sustained period is a very strong indicator of internal memory pressure
-- Memory Clerk Usage for instance (Query 48) (Memory Clerk Usage)
-- Look for high value for CACHESTORE_SQLCP (Ad-hoc query plans)
SELECT TOP(10) mc.[type] AS [Memory Clerk Type],
CAST((SUM(mc.pages_kb)/1024.0) AS DECIMAL (15,2)) AS [Memory Usage (MB)]
FROM sys.dm_os_memory_clerks AS mc WITH (NOLOCK)
GROUP BY mc.[type]
ORDER BY SUM(mc.pages_kb) DESC OPTION (RECOMPILE);
------
-- MEMORYCLERK_SQLBUFFERPOOL was new for SQL Server 2012. It should be your highest consumer of memory
-- CACHESTORE_SQLCP SQL Plans
-- These are cached SQL statements or batches that aren't in stored procedures, functions and triggers
-- Watch out for high values for CACHESTORE_SQLCP
-- Enabling 'optimize for ad hoc workloads' at the instance level can help reduce this
-- Running DBCC FREESYSTEMCACHE ('SQL Plans') periodically may be required to better control this
-- CACHESTORE_OBJCP Object Plans
-- These are compiled plans for stored procedures, functions and triggers
-- sys.dm_os_memory_clerks (Transact-SQL)
-- https://bit.ly/2H31xDR
-- Find single-use, ad-hoc and prepared queries that are bloating the plan cache (Query 49) (Ad hoc Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name], t.[text] AS [Query Text],
cp.objtype AS [Object Type], cp.cacheobjtype AS [Cache Object Type],
cp.size_in_bytes/1024 AS [Plan Size in KB]
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
WHERE cp.cacheobjtype = N'Compiled Plan'
AND cp.objtype IN (N'Adhoc', N'Prepared')
AND cp.usecounts = 1
ORDER BY cp.size_in_bytes DESC, DB_NAME(t.[dbid]) OPTION (RECOMPILE);
------
-- Gives you the text, type and size of single-use ad-hoc and prepared queries that waste space in the plan cache
-- Enabling 'optimize for ad hoc workloads' for the instance can help (SQL Server 2008 and above only)
-- Running DBCC FREESYSTEMCACHE ('SQL Plans') periodically may be required to better control this
-- Enabling forced parameterization for the database can help, but test first!
-- Plan cache, adhoc workloads and clearing the single-use plan cache bloat
-- https://bit.ly/2EfYOkl
-- Get top total logical reads queries for entire instance (Query 50) (Top Logical Reads Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_logical_reads AS [Total Logical Reads],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a memory perspective across the entire instance
-- Can also help track down parameter sniffing issues
-- Get top average elapsed time queries for entire instance (Query 51) (Top Avg Elapsed Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.min_elapsed_time, qs.max_elapsed_time, qs.last_elapsed_time,
qs.execution_count AS [Execution Count],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_physical_reads/qs.execution_count AS [Avg Physical Reads],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_elapsed_time/qs.execution_count DESC OPTION (RECOMPILE);
------
-- Helps you find the highest average elapsed time queries across the entire instance
-- Can also help track down parameter sniffing issues
-- Look at UDF execution statistics (Query 52) (UDF Stats by DB)
SELECT TOP (25) DB_NAME(database_id) AS [Database Name],
OBJECT_NAME(object_id, database_id) AS [Function Name],
total_worker_time, execution_count, total_elapsed_time,
total_elapsed_time/execution_count AS [avg_elapsed_time],
last_elapsed_time, last_execution_time, cached_time, [type_desc]
FROM sys.dm_exec_function_stats WITH (NOLOCK)
ORDER BY total_worker_time DESC OPTION (RECOMPILE);
------
-- sys.dm_exec_function_stats (Transact-SQL)
-- https://bit.ly/2q1Q6BM
-- Showplan Enhancements for UDFs
-- https://bit.ly/2LVqiQ1
-- Database specific queries *****************************************************************
-- **** Please switch to a user database that you are interested in! *****
--USE YourDatabaseName; -- make sure to change to an actual database on your instance, not the master system database
--GO
-- Individual File Sizes and space available for current database (Query 53) (File Sizes and Space)
SELECT f.name AS [File Name] , f.physical_name AS [Physical Name],
CAST((f.size/128.0) AS DECIMAL(15,2)) AS [Total Size in MB],
CAST(f.size/128.0 - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS DECIMAL(15,2))
AS [Available Space In MB], f.[file_id], fg.name AS [Filegroup Name],
f.is_percent_growth, f.growth, fg.is_default, fg.is_read_only,
fg.is_autogrow_all_files
FROM sys.database_files AS f WITH (NOLOCK)
LEFT OUTER JOIN sys.filegroups AS fg WITH (NOLOCK)
ON f.data_space_id = fg.data_space_id
ORDER BY f.[file_id] OPTION (RECOMPILE);
------
-- Look at how large and how full the files are and where they are located
-- Make sure the transaction log is not full!!
-- is_autogrow_all_files was new for SQL Server 2016. Equivalent to TF 1117 for user databases
-- SQL Server 2016: Changes in default behavior for autogrow and allocations for tempdb and user databases
-- https://bit.ly/2evRZSR
-- Log space usage for current database (Query 54) (Log Space Usage)
SELECT DB_NAME(lsu.database_id) AS [Database Name], db.recovery_model_desc AS [Recovery Model],
CAST(lsu.total_log_size_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Total Log Space (MB)],
CAST(lsu.used_log_space_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space (MB)],
CAST(lsu.used_log_space_in_percent AS DECIMAL(10, 2)) AS [Used Log Space %],
CAST(lsu.log_space_in_bytes_since_last_backup/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space Since Last Backup (MB)],
db.log_reuse_wait_desc
FROM sys.dm_db_log_space_usage AS lsu WITH (NOLOCK)
INNER JOIN sys.databases AS db WITH (NOLOCK)
ON lsu.database_id = db.database_id
OPTION (RECOMPILE);
------
-- Look at log file size and usage, along with the log reuse wait description for the current database
-- sys.dm_db_log_space_usage (Transact-SQL)
-- https://bit.ly/2H4MQw9
-- Status of last VLF for current database (Query 55) (Last VLF Status)
SELECT TOP(1) DB_NAME(li.database_id) AS [Database Name], li.[file_id],
li.vlf_size_mb, li.vlf_sequence_number, li.vlf_active, li.vlf_status
FROM sys.dm_db_log_info(DB_ID()) AS li
ORDER BY vlf_sequence_number DESC OPTION (RECOMPILE);
------
-- Determine whether you will be able to shrink the transaction log file
-- vlf_status Values
-- 0 is inactive
-- 1 is initialized but unused
-- 2 is active
-- sys.dm_db_log_info (Transact-SQL)
-- https://bit.ly/2EQUU1v
-- Get database scoped configuration values for current database (Query 56) (Database-scoped Configurations)
SELECT configuration_id, name, [value] AS [value_for_primary], value_for_secondary
FROM sys.database_scoped_configurations WITH (NOLOCK) OPTION (RECOMPILE);
------
-- This lets you see the value of these new properties for the current database
-- Clear plan cache for current database
-- ALTER DATABASE SCOPED CONFIGURATION CLEAR PROCEDURE_CACHE;
-- ALTER DATABASE SCOPED CONFIGURATION (Transact-SQL)
-- https://bit.ly/2sOH7nb
-- I/O Statistics by file for the current database (Query 57) (IO Stats By File)
SELECT DB_NAME(DB_ID()) AS [Database Name], df.name AS [Logical Name], vfs.[file_id], df.type_desc,
df.physical_name AS [Physical Name], CAST(vfs.size_on_disk_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Size on Disk (MB)],
vfs.num_of_reads, vfs.num_of_writes, vfs.io_stall_read_ms, vfs.io_stall_write_ms,
CAST(100. * vfs.io_stall_read_ms/(vfs.io_stall_read_ms + vfs.io_stall_write_ms) AS DECIMAL(10,1)) AS [IO Stall Reads Pct],
CAST(100. * vfs.io_stall_write_ms/(vfs.io_stall_write_ms + vfs.io_stall_read_ms) AS DECIMAL(10,1)) AS [IO Stall Writes Pct],
(vfs.num_of_reads + vfs.num_of_writes) AS [Writes + Reads],
CAST(vfs.num_of_bytes_read/1048576.0 AS DECIMAL(10, 2)) AS [MB Read],
CAST(vfs.num_of_bytes_written/1048576.0 AS DECIMAL(10, 2)) AS [MB Written],
CAST(100. * vfs.num_of_reads/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Reads Pct],
CAST(100. * vfs.num_of_writes/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Write Pct],
CAST(100. * vfs.num_of_bytes_read/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Read Bytes Pct],
CAST(100. * vfs.num_of_bytes_written/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Written Bytes Pct]
FROM sys.dm_io_virtual_file_stats(DB_ID(), NULL) AS vfs
INNER JOIN sys.database_files AS df WITH (NOLOCK)
ON vfs.[file_id]= df.[file_id] OPTION (RECOMPILE);
------
-- This helps you characterize your workload better from an I/O perspective for this database
-- It helps you determine whether you has an OLTP or DW/DSS type of workload
-- Get most frequently executed queries for this database (Query 58) (Query Execution Counts)
SELECT TOP(50) LEFT(t.[text], 50) AS [Short Query Text], qs.execution_count AS [Execution Count],
qs.total_logical_reads AS [Total Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_worker_time AS [Total Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_elapsed_time AS [Total Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Queries 59 through 64 are the "Bad Man List" for stored procedures
-- Top Cached SPs By Execution Count (Query 59) (SP Execution Counts)
SELECT TOP(100) p.name AS [SP Name], qs.execution_count AS [Execution Count],
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Tells you which cached stored procedures are called the most often
-- This helps you characterize and baseline your workload
-- Top Cached SPs By Avg Elapsed Time (Query 60) (SP Avg Elapsed Time)
SELECT TOP(25) p.name AS [SP Name], qs.min_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
qs.max_elapsed_time, qs.last_elapsed_time, qs.total_elapsed_time, qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime],
qs.total_worker_time AS [TotalWorkerTime],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY avg_elapsed_time DESC OPTION (RECOMPILE);
------
-- This helps you find high average elapsed time cached stored procedures that
-- may be easy to optimize with standard query tuning techniques
-- Top Cached SPs By Total Worker time. Worker time relates to CPU cost (Query 61) (SP Worker Time)
SELECT TOP(25) p.name AS [SP Name], qs.total_worker_time AS [TotalWorkerTime],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a CPU perspective
-- You should look at this if you see signs of CPU pressure
-- Top Cached SPs By Total Logical Reads. Logical reads relate to memory pressure (Query 62) (SP Logical Reads)
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_reads AS [TotalLogicalReads],
qs.total_logical_reads/qs.execution_count AS [AvgLogicalReads],qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a memory perspective
-- You should look at this if you see signs of memory pressure
-- Top Cached SPs By Total Physical Reads. Physical reads relate to disk read I/O pressure (Query 63) (SP Physical Reads)
SELECT TOP(25) p.name AS [SP Name],qs.total_physical_reads AS [TotalPhysicalReads],
qs.total_physical_reads/qs.execution_count AS [AvgPhysicalReads], qs.execution_count,
qs.total_logical_reads,qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_physical_reads > 0
ORDER BY qs.total_physical_reads DESC, qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a read I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Top Cached SPs By Total Logical Writes (Query 64) (SP Logical Writes)
-- Logical writes relate to both memory and disk I/O pressure
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_writes AS [TotalLogicalWrites],
qs.total_logical_writes/qs.execution_count AS [AvgLogicalWrites], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_logical_writes > 0
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_writes DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a write I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Lists the top statements by average input/output usage for the current database (Query 65) (Top IO Statements)
SELECT TOP(50) OBJECT_NAME(qt.objectid, dbid) AS [SP Name],
(qs.total_logical_reads + qs.total_logical_writes) /qs.execution_count AS [Avg IO], qs.execution_count AS [Execution Count],
SUBSTRING(qt.[text],qs.statement_start_offset/2,
(CASE
WHEN qs.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE qs.statement_end_offset
END - qs.statement_start_offset)/2) AS [Query Text]
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(qs.sql_handle) AS qt
WHERE qt.[dbid] = DB_ID()
ORDER BY [Avg IO] DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive statements for I/O by SP
-- Possible Bad NC Indexes (writes > reads) (Query 66) (Bad NC Indexes)
SELECT OBJECT_NAME(s.[object_id]) AS [Table Name], i.name AS [Index Name], i.index_id,
i.is_disabled, i.is_hypothetical, i.has_filter, i.fill_factor,
s.user_updates AS [Total Writes], s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
s.user_updates - (s.user_seeks + s.user_scans + s.user_lookups) AS [Difference]
FROM sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON s.[object_id] = i.[object_id]
AND i.index_id = s.index_id
WHERE OBJECTPROPERTY(s.[object_id],'IsUserTable') = 1
AND s.database_id = DB_ID()
AND s.user_updates > (s.user_seeks + s.user_scans + s.user_lookups)
AND i.index_id > 1 AND i.[type_desc] = N'NONCLUSTERED'
AND i.is_primary_key = 0 AND i.is_unique_constraint = 0 AND i.is_unique = 0
ORDER BY [Difference] DESC, [Total Writes] DESC, [Total Reads] ASC OPTION (RECOMPILE);
------
-- Look for indexes with high numbers of writes and zero or very low numbers of reads
-- Consider your complete workload, and how long your instance has been running
-- Investigate further before dropping an index!
-- Missing Indexes for current database by Index Advantage (Query 67) (Missing Indexes)
SELECT DISTINCT CONVERT(decimal(18,2), user_seeks * avg_total_user_cost * (avg_user_impact * 0.01)) AS [index_advantage],
migs.last_user_seek, mid.[statement] AS [Database.Schema.Table],
mid.equality_columns, mid.inequality_columns, mid.included_columns,
migs.unique_compiles, migs.user_seeks, migs.avg_total_user_cost, migs.avg_user_impact,
OBJECT_NAME(mid.[object_id]) AS [Table Name], p.rows AS [Table Rows]
FROM sys.dm_db_missing_index_group_stats AS migs WITH (NOLOCK)
INNER JOIN sys.dm_db_missing_index_groups AS mig WITH (NOLOCK)
ON migs.group_handle = mig.index_group_handle
INNER JOIN sys.dm_db_missing_index_details AS mid WITH (NOLOCK)
ON mig.index_handle = mid.index_handle
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON p.[object_id] = mid.[object_id]
WHERE mid.database_id = DB_ID()
AND p.index_id < 2
ORDER BY index_advantage DESC OPTION (RECOMPILE);
------
-- Look at index advantage, last user seek time, number of user seeks to help determine source and importance
-- SQL Server is overly eager to add included columns, so beware
-- Do not just blindly add indexes that show up from this query!!!
-- Find missing index warnings for cached plans in the current database (Query 68) (Missing Index Warnings)
-- Note: This query could take some time on a busy instance
SELECT TOP(25) OBJECT_NAME(objectid) AS [ObjectName],
cp.objtype, cp.usecounts, cp.size_in_bytes, query_plan
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_query_plan(cp.plan_handle) AS qp
WHERE CAST(query_plan AS NVARCHAR(MAX)) LIKE N'%MissingIndex%'
AND dbid = DB_ID()
ORDER BY cp.usecounts DESC OPTION (RECOMPILE);
------
-- Helps you connect missing indexes to specific stored procedures or queries
-- This can help you decide whether to add them or not
-- Breaks down buffers used by current database by object (table, index) in the buffer cache (Query 69) (Buffer Usage)
-- Note: This query could take some time on a busy instance
SELECT OBJECT_NAME(p.[object_id]) AS [Object Name], p.index_id,
CAST(COUNT(*)/128.0 AS DECIMAL(10, 2)) AS [Buffer size(MB)],
COUNT(*) AS [BufferCount], p.[Rows] AS [Row Count],
p.data_compression_desc AS [Compression Type]
FROM sys.allocation_units AS a WITH (NOLOCK)
INNER JOIN sys.dm_os_buffer_descriptors AS b WITH (NOLOCK)
ON a.allocation_unit_id = b.allocation_unit_id
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON a.container_id = p.hobt_id
WHERE b.database_id = CONVERT(int, DB_ID())
AND p.[object_id] > 100
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'plan_%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'sys%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'xml_index_nodes%'
GROUP BY p.[object_id], p.index_id, p.data_compression_desc, p.[Rows]
ORDER BY [BufferCount] DESC OPTION (RECOMPILE);
------
-- Tells you what tables and indexes are using the most memory in the buffer cache
-- It can help identify possible candidates for data compression
-- Get Table names, row counts, and compression status for clustered index or heap (Query 70) (Table Sizes)
SELECT OBJECT_NAME(object_id) AS [ObjectName],
SUM(Rows) AS [RowCount], data_compression_desc AS [CompressionType]
FROM sys.partitions WITH (NOLOCK)
WHERE index_id < 2 --ignore the partitions from the non-clustered index if any
AND OBJECT_NAME(object_id) NOT LIKE N'sys%'
AND OBJECT_NAME(object_id) NOT LIKE N'queue_%'
AND OBJECT_NAME(object_id) NOT LIKE N'filestream_tombstone%'
AND OBJECT_NAME(object_id) NOT LIKE N'fulltext%'
AND OBJECT_NAME(object_id) NOT LIKE N'ifts_comp_fragment%'
AND OBJECT_NAME(object_id) NOT LIKE N'filetable_updates%'
AND OBJECT_NAME(object_id) NOT LIKE N'xml_index_nodes%'
AND OBJECT_NAME(object_id) NOT LIKE N'sqlagent_job%'
AND OBJECT_NAME(object_id) NOT LIKE N'plan_persist%'
GROUP BY object_id, data_compression_desc
ORDER BY SUM(Rows) DESC OPTION (RECOMPILE);
------
-- Gives you an idea of table sizes, and possible data compression opportunities
-- Get some key table properties (Query 71) (Table Properties)
SELECT OBJECT_NAME(t.[object_id]) AS [ObjectName], p.[rows] AS [Table Rows], p.index_id,
p.data_compression_desc AS [Index Data Compression],
t.create_date, t.lock_on_bulk_load, t.is_replicated, t.has_replication_filter,
t.is_tracked_by_cdc, t.lock_escalation_desc, t.is_filetable,
t.is_memory_optimized, t.durability_desc,
t.temporal_type_desc, t.is_remote_data_archive_enabled, t.is_external -- new for SQL Server 2016
FROM sys.tables AS t WITH (NOLOCK)
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON t.[object_id] = p.[object_id]
WHERE OBJECT_NAME(t.[object_id]) NOT LIKE N'sys%'
ORDER BY OBJECT_NAME(t.[object_id]), p.index_id OPTION (RECOMPILE);
------
-- Gives you some good information about your tables
-- is_memory_optimized and durability_desc were new in SQL Server 2014
-- temporal_type_desc, is_remote_data_archive_enabled, is_external were new in SQL Server 2016
-- sys.tables (Transact-SQL)
-- https://bit.ly/2Gk7998
-- When were Statistics last updated on all indexes? (Query 72) (Statistics Update)
SELECT SCHEMA_NAME(o.Schema_ID) + N'.' + o.[NAME] AS [Object Name], o.[type_desc] AS [Object Type],
i.[name] AS [Index Name], STATS_DATE(i.[object_id], i.index_id) AS [Statistics Date],
s.auto_created, s.no_recompute, s.user_created, s.is_incremental, s.is_temporary,
st.row_count, st.used_page_count
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON o.[object_id] = i.[object_id]
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.stats_id
INNER JOIN sys.dm_db_partition_stats AS st WITH (NOLOCK)
ON o.[object_id] = st.[object_id]
AND i.[index_id] = st.[index_id]
WHERE o.[type] IN ('U', 'V')
AND st.row_count > 0
ORDER BY STATS_DATE(i.[object_id], i.index_id) DESC OPTION (RECOMPILE);
------
-- Helps discover possible problems with out-of-date statistics
-- Also gives you an idea which indexes are the most active
-- sys.stats (Transact-SQL)
-- https://bit.ly/2GyAxrn
-- UPDATEs to Statistics (Erin Stellato)
-- https://bit.ly/2vhrYQy
-- Look at most frequently modified indexes and statistics (Query 73) (Volatile Indexes)
SELECT o.[name] AS [Object Name], o.[object_id], o.[type_desc], s.[name] AS [Statistics Name],
s.stats_id, s.no_recompute, s.auto_created, s.is_incremental, s.is_temporary,
sp.modification_counter, sp.[rows], sp.rows_sampled, sp.last_updated
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON s.object_id = o.object_id
CROSS APPLY sys.dm_db_stats_properties(s.object_id, s.stats_id) AS sp
WHERE o.[type_desc] NOT IN (N'SYSTEM_TABLE', N'INTERNAL_TABLE')
AND sp.modification_counter > 0
ORDER BY sp.modification_counter DESC, o.name OPTION (RECOMPILE);
------
-- This helps you understand your workload and make better decisions about
-- things like data compression and adding new indexes to a table
-- Get fragmentation info for all indexes above a certain size in the current database (Query 74) (Index Fragmentation)
-- Note: This query could take some time on a very large database
SELECT DB_NAME(ps.database_id) AS [Database Name], SCHEMA_NAME(o.[schema_id]) AS [Schema Name],
OBJECT_NAME(ps.OBJECT_ID) AS [Object Name], i.[name] AS [Index Name], ps.index_id,
ps.index_type_desc, ps.avg_fragmentation_in_percent,
ps.fragment_count, ps.page_count, i.fill_factor, i.has_filter,
i.filter_definition, i.[allow_page_locks]
FROM sys.dm_db_index_physical_stats(DB_ID(),NULL, NULL, NULL , N'LIMITED') AS ps
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.[object_id] = i.[object_id]
AND ps.index_id = i.index_id
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON i.[object_id] = o.[object_id]
WHERE ps.database_id = DB_ID()
AND ps.page_count > 2500
ORDER BY ps.avg_fragmentation_in_percent DESC OPTION (RECOMPILE);
------
-- Helps determine whether you have framentation in your relational indexes
-- and how effective your index maintenance strategy is
--- Index Read/Write stats (all tables in current DB) ordered by Reads (Query 75) (Overall Index Usage - Reads)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_seeks, s.user_scans, s.user_lookups,
s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
s.user_updates AS [Writes],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_user_scan, s.last_user_lookup, s.last_user_seek
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_seeks + s.user_scans + s.user_lookups DESC OPTION (RECOMPILE); -- Order by reads
------
-- Show which indexes in the current database are most active for Reads
--- Index Read/Write stats (all tables in current DB) ordered by Writes (Query 76) (Overall Index Usage - Writes)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_updates AS [Writes], s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_system_update, s.last_user_update
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_updates DESC OPTION (RECOMPILE); -- Order by writes
------
-- Show which indexes in the current database are most active for Writes
-- Get in-memory OLTP index usage (Query 77) (XTP Index Usage)
SELECT OBJECT_NAME(i.[object_id]) AS [Object Name], i.index_id, i.[name] AS [Index Name],
i.[type_desc], xis.scans_started, xis.scans_retries,
xis.rows_touched, xis.rows_returned
FROM sys.dm_db_xtp_index_stats AS xis WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON i.[object_id] = xis.[object_id]
AND i.index_id = xis.index_id
ORDER BY OBJECT_NAME(i.[object_id]) OPTION (RECOMPILE);
------
-- This gives you some index usage statistics for in-memory OLTP
-- Returns no data if you are not using in-memory OLTP
-- Guidelines for Using Indexes on Memory-Optimized Tables
-- https://bit.ly/2GCP8lF
-- Look at Columnstore index physical statistics (Query 78) (Columnstore Index Physical Stat)
SELECT OBJECT_NAME(ps.object_id) AS [TableName],
i.[name] AS [IndexName], ps.index_id, ps.partition_number,
ps.delta_store_hobt_id, ps.state_desc, ps.total_rows, ps.size_in_bytes,
ps.trim_reason_desc, ps.generation, ps.transition_to_compressed_state_desc,
ps.has_vertipaq_optimization, ps.deleted_rows,
100 * (ISNULL(ps.deleted_rows, 0))/ps.total_rows AS [Fragmentation]
FROM sys.dm_db_column_store_row_group_physical_stats AS ps WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.object_id = i.object_id
AND ps.index_id = i.index_id
ORDER BY ps.object_id, ps.partition_number, ps.row_group_id OPTION (RECOMPILE);
------
-- sys.dm_db_column_store_row_group_physical_stats (Transact-SQL)
-- https://bit.ly/2q276XQ
-- Get lock waits for current database (Query 79) (Lock Waits)
SELECT o.name AS [table_name], i.name AS [index_name], ios.index_id, ios.partition_number,
SUM(ios.row_lock_wait_count) AS [total_row_lock_waits],
SUM(ios.row_lock_wait_in_ms) AS [total_row_lock_wait_in_ms],
SUM(ios.page_lock_wait_count) AS [total_page_lock_waits],
SUM(ios.page_lock_wait_in_ms) AS [total_page_lock_wait_in_ms],
SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) AS [total_lock_wait_in_ms]
FROM sys.dm_db_index_operational_stats(DB_ID(), NULL, NULL, NULL) AS ios
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON ios.[object_id] = o.[object_id]
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ios.[object_id] = i.[object_id]
AND ios.index_id = i.index_id
WHERE o.[object_id] > 100
GROUP BY o.name, i.name, ios.index_id, ios.partition_number
HAVING SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) > 0
ORDER BY total_lock_wait_in_ms DESC OPTION (RECOMPILE);
------
-- This query is helpful for troubleshooting blocking and deadlocking issues
-- Look at UDF execution statistics (Query 80) (UDF Statistics)
SELECT OBJECT_NAME(object_id) AS [Function Name], execution_count,
total_worker_time, total_logical_reads, total_physical_reads, total_elapsed_time,
total_elapsed_time/execution_count AS [avg_elapsed_time],
FORMAT(cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
FROM sys.dm_exec_function_stats WITH (NOLOCK)
WHERE database_id = DB_ID()
ORDER BY total_worker_time DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Helps you investigate scalar UDF performance issues
-- Does not return information for table valued functions
-- sys.dm_exec_function_stats (Transact-SQL)
-- https://bit.ly/2q1Q6BM
-- Get QueryStore Options for this database (Query 81) (QueryStore Options)
SELECT actual_state_desc, desired_state_desc, [interval_length_minutes],
current_storage_size_mb, [max_storage_size_mb],
query_capture_mode_desc, size_based_cleanup_mode_desc
FROM sys.database_query_store_options WITH (NOLOCK) OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that Query Store is enabled for this database
-- Make sure that the actual_state_desc is the same as desired_state_desc
-- Make sure that the current_storage_size_mb is less than the max_storage_size_mb
-- Tuning Workload Performance with Query Store
-- https://bit.ly/1kHSl7w
-- Get highest aggregate duration queries over last hour (Query 82) (High Aggregate Duration Queries)
WITH AggregatedDurationLastHour
AS
(SELECT q.query_id, SUM(rs.count_executions * rs.avg_duration) AS total_duration,
COUNT (DISTINCT p.plan_id) AS number_of_plans
FROM sys.query_store_query_text AS qt WITH (NOLOCK)
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON qt.query_text_id = q.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
INNER JOIN sys.query_store_runtime_stats AS rs WITH (NOLOCK)
ON rs.plan_id = p.plan_id
INNER JOIN sys.query_store_runtime_stats_interval AS rsi WITH (NOLOCK)
ON rsi.runtime_stats_interval_id = rs.runtime_stats_interval_id
WHERE rsi.start_time >= DATEADD(hour, -1, GETUTCDATE())
AND rs.execution_type_desc = N'Regular'
GROUP BY q.query_id), OrderedDuration
AS
(SELECT query_id, total_duration, number_of_plans,
ROW_NUMBER () OVER (ORDER BY total_duration DESC, query_id) AS RN
FROM AggregatedDurationLastHour)
SELECT OBJECT_NAME(q.object_id) AS [Containing Object], qt.query_sql_text,
od.total_duration AS [Total Duration (microsecs)],
od.number_of_plans AS [Plan Count],
p.is_forced_plan, p.is_parallel_plan, p.is_trivial_plan,
q.query_parameterization_type_desc, p.[compatibility_level],
p.last_compile_start_time,
q.last_execution_time,
CONVERT(xml, p.query_plan) AS query_plan_xml
FROM OrderedDuration AS od
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON q.query_id = od.query_id
INNER JOIN sys.query_store_query_text AS qt WITH (NOLOCK)
ON q.query_text_id = qt.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
WHERE od.RN <= 50
ORDER BY od.total_duration DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that QueryStore is enabled for this database
-- Get highest aggregate CPU time queries over last hour (Query 83) (High Aggregate CPU Queries)
WITH AggregatedCPULastHour
AS
(SELECT q.query_id, SUM(rs.count_executions * rs.avg_cpu_time) AS total_cpu_time,
COUNT (DISTINCT p.plan_id) AS number_of_plans
FROM sys.query_store_query_text AS qt WITH (NOLOCK)
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON qt.query_text_id = q.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
INNER JOIN sys.query_store_runtime_stats AS rs WITH (NOLOCK)
ON rs.plan_id = p.plan_id
INNER JOIN sys.query_store_runtime_stats_interval AS rsi WITH (NOLOCK)
ON rsi.runtime_stats_interval_id = rs.runtime_stats_interval_id
WHERE rsi.start_time >= DATEADD(hour, -1, GETUTCDATE())
AND rs.execution_type_desc = N'Regular'
GROUP BY q.query_id), OrderedDuration
AS
(SELECT query_id, total_cpu_time, number_of_plans,
ROW_NUMBER () OVER (ORDER BY total_cpu_time DESC, query_id) AS RN
FROM AggregatedCPULastHour)
SELECT OBJECT_NAME(q.object_id) AS [Containing Object], qt.query_sql_text,
od.total_cpu_time AS [Total CPU Time (microsecs)],
od.number_of_plans AS [Plan Count],
p.is_forced_plan, p.is_parallel_plan, p.is_trivial_plan,
q.query_parameterization_type_desc, p.[compatibility_level],
p.last_compile_start_time,
q.last_execution_time,
CONVERT(xml, p.query_plan) AS query_plan_xml
FROM OrderedDuration AS od
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON q.query_id = od.query_id
INNER JOIN sys.query_store_query_text AS qt WITH (NOLOCK)
ON q.query_text_id = qt.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
WHERE od.RN <= 50
ORDER BY od.total_cpu_time DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that QueryStore is enabled for this database
-- Get input buffer information for the current database (Query 84) (Input Buffer)
SELECT es.session_id, DB_NAME(es.database_id) AS [Database Name],
es.login_time, es.cpu_time, es.logical_reads, es.memory_usage,
es.[status], ib.event_info AS [Input Buffer]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
CROSS APPLY sys.dm_exec_input_buffer(es.session_id, NULL) AS ib
WHERE es.database_id = DB_ID()
AND es.session_id > 50
AND es.session_id <> @@SPID OPTION (RECOMPILE);
------
-- Gives you input buffer information from all non-system sessions for the current database
-- Replaces DBCC INPUTBUFFER
-- New DMF for retrieving input buffer in SQL Server
-- https://bit.ly/2uHKMbz
-- sys.dm_exec_input_buffer (Transact-SQL)
-- https://bit.ly/2J5Hf9q
-- Get any resumable index rebuild operation information (Query 85) (Resumable Index Rebuild)
SELECT OBJECT_NAME(iro.object_id) AS [Object Name], iro.index_id, iro.name AS [Index Name],
iro.sql_text, iro.last_max_dop_used, iro.partition_number, iro.state_desc, iro.start_time, iro.percent_complete
FROM sys.index_resumable_operations AS iro WITH (NOLOCK)
OPTION (RECOMPILE);
------
-- index_resumable_operations (Transact-SQL)
-- https://bit.ly/2pYSWqq
-- Get database automatic tuning options (Query 86) (Automatic Tuning Options)
SELECT [name], desired_state_desc, actual_state_desc, reason_desc
FROM sys.database_automatic_tuning_options WITH (NOLOCK)
OPTION (RECOMPILE);
------
-- sys.database_automatic_tuning_options (Transact-SQL)
-- https://bit.ly/2FHhLkL
-- Look at recent Full backups for the current database (Query 87) (Recent Full Backups)
SELECT TOP (30) bs.machine_name, bs.server_name, bs.database_name AS [Database Name], bs.recovery_model,
CONVERT (BIGINT, bs.backup_size / 1048576 ) AS [Uncompressed Backup Size (MB)],
CONVERT (BIGINT, bs.compressed_backup_size / 1048576 ) AS [Compressed Backup Size (MB)],
CONVERT (NUMERIC (20,2), (CONVERT (FLOAT, bs.backup_size) /
CONVERT (FLOAT, bs.compressed_backup_size))) AS [Compression Ratio], bs.has_backup_checksums, bs.is_copy_only, bs.encryptor_type,
DATEDIFF (SECOND, bs.backup_start_date, bs.backup_finish_date) AS [Backup Elapsed Time (sec)],
bs.backup_finish_date AS [Backup Finish Date], bmf.physical_device_name AS [Backup Location], bmf.physical_block_size
FROM msdb.dbo.backupset AS bs WITH (NOLOCK)
INNER JOIN msdb.dbo.backupmediafamily AS bmf WITH (NOLOCK)
ON bs.media_set_id = bmf.media_set_id
WHERE bs.database_name = DB_NAME(DB_ID())
AND bs.[type] = 'D' -- Change to L if you want Log backups
ORDER BY bs.backup_finish_date DESC OPTION (RECOMPILE);
------
-- Are your backup sizes and times changing over time?
-- Are you using backup compression?
-- Are you using backup checksums?
-- Are you doing copy_only backups?
-- Are you doing encrypted backups?
-- Have you done any backup tuning with striped backups, or changing the parameters of the backup command?
-- In SQL Server 2016, native SQL Server backup compression actually works
-- much better with databases that are using TDE than in previous versions
-- https://bit.ly/28Rpb2x
-- These four Pluralsight Courses go into more detail about how to run these queries and interpret the results
-- SQL Server 2017: Diagnosing Configuration Issues with DMVs
-- https://bit.ly/2MSUDUL
-- SQL Server 2014 DMV Diagnostic Queries � Part 1
-- https://bit.ly/2plxCer
-- SQL Server 2014 DMV Diagnostic Queries � Part 2
-- https://bit.ly/2IuJpzI
-- SQL Server 2014 DMV Diagnostic Queries � Part 3
-- https://bit.ly/2FIlCPb
-- Sign up for Microsoft Visual Studio Dev Essentials and get a free three month pass to Pluralsight
-- Microsoft Visual Studio Dev Essentials
-- http://bit.ly/1q6xbDL
-- Sign up for Microsoft Azure Essentials and get lots of free Azure usage credits, MCP exam voucher, three month Pluralsight subscription
-- Microsoft Azure Essentials
-- https://bit.ly/2JMWe8x
-- August 2017 blog series about upgrading and migrating to SQL Server 2016/2017
-- https://bit.ly/2ftKVrX
md5: 54A947A8CED5A122FFA7B0A84041420E | sha1: C631EA3C22410A317252CAF41950B75F4C5488BE | sha256: 17AB90D36B5E3E3F4D76E80213C9B539448FDD46FAFD2CBD306465044C1629EC | sha512: A7AF2D5E7A3E8DACDD44B9492C4A14C78633B51D0AEE58EDFE88EFC9D231C78F3CC42D66948DB8A1C58F44434B864EAE9D367C4E8F7B19A4099847D59A9DE07F
md5: B5AFC86E733FE19DAE8A6DFB71901A4E | sha1: F076620639B6EAF2A086292D46F479457730ACAA | sha256: 6387E707E5A9983C27879462AE1A9FE0AD336A27425113EE064380B7B006CD71 | sha512: 44469F97E547AE8B8EB18557BB2B607C3EAF914B0A1F9FC2691FA46493D6CDD554E52FA9F0147A7560D3C5D2E7F5B006ACDB65558340C9C5433016965AC0EC72
md5: B3A6CA5EE94FF2E86811D687658555C1 | sha1: 5D22774B875DEC5AC4BDF36BF69C05E7E6280A81 | sha256: 1C3B90F76D5E7908C15688F5138EECDBC208D3C4D33ACE7CA79BCC52B3A17F14 | sha512: A76524B0D47BA4E5AE36A3EB9523AB598ABE7BB9F0C7354E2FDC278C3DFDA4CD2051749F36E8309E1D85ADD6392BEC93BB858E1622A3EE7F07B016A7AF24C314
md5: C6CC649FA71CA67148297E8A5993DBE3 | sha1: 82CDF6397A03D9B8931A6BC8D6296951F790FB35 | sha256: EFF493CEFF05385D55183A1FBC45311AD92781A5484FB0E15A725016B7EFB8D9 | sha512: 6D655FE5BBE7A6B644F9A21F54613189DB9C55BD560B7D9565873650137ECB8EBAFC4DE1F04E4338E8EC670716394ECE9850C0DA654111D27F54FEDF9E15B474
md5: B628255C8F1E2AFBCCF2D8DBF02779E4 | sha1: 2F53622D555DDD30882CF128AD69C38A1F4E392C | sha256: 25C8FBEA431843B4150E2E4A770139C3B52C8D3EEBA983D38B03313F00271D7E | sha512: 702F2036C303BD97C7A6A76EE79B03A0B46D604A0FAD306FEEE023D6857CACFFDBD291E95D094607AF5A90456F3C971E5939D91A43E8C37BBBEE911BA24B2BFB
md5: 04C9A563ED69D537D753B5A45F870B44 | sha1: 28EBC515826108FA736A5D34DDDCAE86A52FFC10 | sha256: 09AE9F682D0E610AE4C560891EB103C2F1E16B18780CC60856EEA5B953402F5D | sha512: 963CA4299050C8ECCE9D1DDD5DD569A9CC1E241880D6294D5E8D3CDD2E05A42B3ABB483013C96BF5F18B27BF1C39BF68484503F61D66DCA587C527CA7675CF22
md5: 906581DA5946FE4352DB4BE645911E0C | sha1: 300CB414E57056A738458294C2EE712C11F1D526 | sha256: D05BD284A6A0D8E7A17E690A11B41365AD60AC8B350656E50B15C31C444AB4E0 | sha512: 1AC03C3F4B2EEE7F02A264A8D600B69746F66C4F7312736CEA2C9BD1113B11E1FDAC9040838B4E1EC696D7329B7964859C1FEA1834976E3FAF35BA2C6E0F0996
md5: C35C5E48D1B31934489AC69C41929952 | sha1: 8FC17A2E3F774429E87EE8AD0EA609C4E9BB43C9 | sha256: 2FC3B752B425B64CB127E224834FE00781A82232DD97EAB9E4B10A23B03A6896 | sha512: 5F770C9D3C7B9FEEC2F24B43F94DA5976F5559ED103568AF69EFC10E95DCB363273D198A355410B2B03CB6E1463A7967382CBD4820F9D5DB66DEFADDFFB9931A
md5: 9B2DA9E2F4CA29792614DA567EEE4DB4 | sha1: C44D1E8DEBBF1E197F4DF8F1FB7786EDDB00420E | sha256: 28DB74E05232B7C15F2832C548B77998164730D959564A3652CAD4937F445221 | sha512: 9449A2A614A9D06723B7687F933DB42984414DDDD4EAE8C0D807251E21199FD6ED8A3221BC29AA813121EE4D609785F7D085140725B5274F3AE3EBFFCDBAC3C7
-- SQL Server 2016 Diagnostic Information Queries
-- Glenn Berry
-- Last Modified: September 11, 2018
-- https://www.sqlskills.com/blogs/glenn/
-- http://sqlserverperformance.wordpress.com/
-- Twitter: GlennAlanBerry
-- Please listen to my Pluralsight courses
-- https://www.pluralsight.com/author/glenn-berry
-- If you want to find all of our SQLskills SQL101 blog posts, check out https://www.sqlskills.com/help/sql101/
-- Please make sure you are using the correct version of these diagnostic queries for your version of SQL Server
-- If you like PowerShell, there is a very useful community solution for running these queries in an automated fashion
-- https://dbatools.io/
-- Invoke-DbaDiagnosticQuery
-- https://dbatools.io/functions/invoke-dbadiagnosticquery/
--******************************************************************************
--* Copyright (C) 2018 Glenn Berry, SQLskills.com
--* All rights reserved.
--*
--* For more scripts and sample code, check out
--* https://www.sqlskills.com/blogs/glenn
--*
--* You may alter this code for your own *non-commercial* purposes. You may
--* republish altered code as long as you include this copyright and give due credit.
--*
--*
--* THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF
--* ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED
--* TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
--* PARTICULAR PURPOSE.
--*
--******************************************************************************
-- Check the major product version to see if it is SQL Server 2016 CTP 2 or greater
IF NOT EXISTS (SELECT * WHERE CONVERT(varchar(128), SERVERPROPERTY('ProductVersion')) LIKE '13%')
BEGIN
DECLARE @ProductVersion varchar(128) = CONVERT(varchar(128), SERVERPROPERTY('ProductVersion'));
RAISERROR ('Script does not match the ProductVersion [%s] of this instance. Many of these queries may not work on this version.' , 18 , 16 , @ProductVersion);
END
ELSE
PRINT N'You have the correct major version of SQL Server for this diagnostic information script';
-- Instance level queries *******************************
-- SQL and OS Version information for current instance (Query 1) (Version Info)
SELECT @@SERVERNAME AS [Server Name], @@VERSION AS [SQL Server and OS Version Info];
------
-- SQL Server 2016 RTM Branch Builds -- SQL Server 2016 SP1 Branch Builds -- SQL Server 2016 SP2 Branch Builds
-- Build Description Release Date Build Description Release Date Build Description Release Date
-- 13.0.200.172 CTP 2.0 5/26/2015
-- 13.0.300.44 CTP 2.1 6/14/2015
-- 13.0.407.1 CTP 2.2 7/28/2015
-- 13.0.500.53 CTP 2.3 9/4/2015
-- 13.0.600.65 CTP 2.4 9/30/2015
-- 13.0.700.242 CTP 3.0 10/29/2015
-- 13.0.900.73 CTP 3.2 12/12/2015
-- 13.0.1000.276 CTP 3.3 1/27/2016
-- 13.0.1100.288 RC0 3/2/2016
-- 13.0.1200.242 RC1 3/18/2016
-- 13.0.1300.275 RC2 3/28/2016
-- 13.0.1400.361 RC3 4/11/2016
-- 13.0.1601.5 RTM 6/1/2016
-- 13.0.1708.0 RTM-GDR 6/12/2016
-- 13.0.2149.0 RTM CU1 7/25/2016
-- 13.0.2164.0 RTM CU2 9/22/2016
-- 13.0.2186.0 RTM CU3 11/16/2016 ----> 13.0.4001.0 SP1 RTM 11/16/2016
-- 13.0.2193.0 RTM CU4 1/18/2017 ----> 13.0.4411.0 SP1 CU1 1/18/2017
-- 13.0.2197.0 RTM CU5 3/20/2017 ----> 13.0.4422.0 SP1 CU2 3/20/2017
-- 13.0.2204.0 RTM CU6 5/15/2017 ----> 13.0.4435.0 SP1 CU3 5/15/2017
-- 13.0.2210.0 RTM CU7 8/8/2017 ----> 13.0.4446.0 SP1 CU4 8/8/2017
-- 13.0.2213.0 RTM CU8 9/18/2017 ----> 13.0.4451.0 SP1 CU5 9/18/2017
-- 13.0.2216.0 RTM CU9 11/21/2017 ----> 13.0.4457.0 SP1 CU6 11/21/2017
-- 13.0.4466.4 SP1 CU7 1/4/2018
-- 13.0.4474.0 SP1 CU8 3/20/2018 ----> 13.0.5026.0 SP2 RTM 4/24/2018
-- 13.0.4502.0 SP1 CU9 5/30/2018 ----> 13.0.5149.0 SP2 CU1 5/30/2018
-- 13.0.4514.0 SP1 CU10 7/16/2018 ----> 13.0.5153.0 SP2 CU2 7/16/2018
-- How to determine the version, edition and update level of SQL Server and its components
-- https://bit.ly/2oAjKgW
-- How to obtain the latest Service Pack for SQL Server 2016
-- https://bit.ly/2egtfzK
-- Microsoft SQL Server 2016 SP1 Latest Cumulative Update
-- https://bit.ly/2jTwxWC
-- SQL Server 2016 build versions
-- https://bit.ly/2epkTDT
-- Where to find information about the latest SQL Server builds
-- https://bit.ly/2IGHbfY
-- Performance and Stability Related Fixes in Post-SQL Server 2016 SP1 Builds
-- https://bit.ly/2gr7k9L
-- Performance and Stability Related Fixes in Post-SQL Server 2016 SP2 Builds
-- https://bit.ly/2K3LoPf
-- Announcing updates to the SQL Server Incremental Servicing Model (ISM)
-- https://bit.ly/1RzYITz
-- Update Center for Microsoft SQL Server
-- https://bit.ly/2pZptuQ
-- Download SQL Server Management Studio (SSMS)
-- https://bit.ly/1OcupT9
-- Download and install Microsoft SQL Operations Studio
-- https://bit.ly/2vgke1A
-- Get socket, physical core and logical core count from the SQL Server Error log. (Query 2) (Core Counts)
-- This query might take a few seconds depending on the size of your error log
EXEC sys.xp_readerrorlog 0, 1, N'detected', N'socket';
------
-- This can help you determine the exact core counts used by SQL Server and whether HT is enabled or not
-- It can also help you confirm your SQL Server licensing model
-- Be on the lookout for this message "using 40 logical processors based on SQL Server licensing"
-- (when you have more than 40 logical cores) which means grandfathered Server/CAL licensing
-- This query will return no results if your error log has been recycled since the instance was last started
-- Get selected server properties (Query 3) (Server Properties)
SELECT SERVERPROPERTY('MachineName') AS [MachineName],
SERVERPROPERTY('ServerName') AS [ServerName],
SERVERPROPERTY('InstanceName') AS [Instance],
SERVERPROPERTY('IsClustered') AS [IsClustered],
SERVERPROPERTY('ComputerNamePhysicalNetBIOS') AS [ComputerNamePhysicalNetBIOS],
SERVERPROPERTY('Edition') AS [Edition],
SERVERPROPERTY('ProductLevel') AS [ProductLevel], -- What servicing branch (RTM/SP/CU)
SERVERPROPERTY('ProductUpdateLevel') AS [ProductUpdateLevel], -- Within a servicing branch, what CU# is applied
SERVERPROPERTY('ProductVersion') AS [ProductVersion],
SERVERPROPERTY('ProductMajorVersion') AS [ProductMajorVersion],
SERVERPROPERTY('ProductMinorVersion') AS [ProductMinorVersion],
SERVERPROPERTY('ProductBuild') AS [ProductBuild],
SERVERPROPERTY('ProductBuildType') AS [ProductBuildType], -- Is this a GDR or OD hotfix (NULL if on a CU build)
SERVERPROPERTY('ProductUpdateReference') AS [ProductUpdateReference], -- KB article number that is applicable for this build
SERVERPROPERTY('ProcessID') AS [ProcessID],
SERVERPROPERTY('Collation') AS [Collation],
SERVERPROPERTY('IsFullTextInstalled') AS [IsFullTextInstalled],
SERVERPROPERTY('IsIntegratedSecurityOnly') AS [IsIntegratedSecurityOnly],
SERVERPROPERTY('FilestreamConfiguredLevel') AS [FilestreamConfiguredLevel],
SERVERPROPERTY('IsHadrEnabled') AS [IsHadrEnabled],
SERVERPROPERTY('HadrManagerStatus') AS [HadrManagerStatus],
SERVERPROPERTY('InstanceDefaultDataPath') AS [InstanceDefaultDataPath],
SERVERPROPERTY('InstanceDefaultLogPath') AS [InstanceDefaultLogPath],
SERVERPROPERTY('BuildClrVersion') AS [Build CLR Version],
SERVERPROPERTY('IsXTPSupported') AS [IsXTPSupported],
SERVERPROPERTY('IsPolybaseInstalled') AS [IsPolybaseInstalled], -- New for SQL Server 2016
SERVERPROPERTY('IsAdvancedAnalyticsInstalled') AS [IsRServicesInstalled]; -- New for SQL Server 2016
------
-- This gives you a lot of useful information about your instance of SQL Server,
-- such as the ProcessID for SQL Server and your collation
-- Note: Some columns will be NULL on older SQL Server builds
-- SERVERPROPERTY (Transact-SQL)
-- https://bit.ly/2eeaXeI
-- Get instance-level configuration values for instance (Query 4) (Configuration Values)
SELECT name, value, value_in_use, minimum, maximum, [description], is_dynamic, is_advanced
FROM sys.configurations WITH (NOLOCK)
ORDER BY name OPTION (RECOMPILE);
------
-- Focus on these settings:
-- automatic soft-NUMA disabled (should be 0 in most cases)
-- backup checksum default (should be 1)
-- backup compression default (should be 1 in most cases)
-- clr enabled (only enable if it is needed)
-- cost threshold for parallelism (depends on your workload)
-- lightweight pooling (should be zero)
-- max degree of parallelism (depends on your workload and hardware)
-- max server memory (MB) (set to an appropriate value, not the default)
-- optimize for ad hoc workloads (should be 1)
-- priority boost (should be zero)
-- remote admin connections (should be 1)
-- New configuration options for SQL Server 2016
-- allow polybase export (Allow INSERT into a Hadoop external table)
-- automatic soft-NUMA disabled (Automatic soft-NUMA is enabled by default)
-- external scripts enabled (Allows execution of external scripts, for R Services)
-- hadoop connectivity (Configure SQL Server to connect to external Hadoop or Microsoft Azure storage blob data sources through PolyBase)
-- polybase network encryption (Configure SQL Server to encrypt control and data channels when using PolyBase)
-- remote data archive (Allow the use of the REMOTE_DATA_ARCHIVE data access for Stretch databases)
-- SQLSweet16!, Episode 1: Backup Compression for TDE-enabled Databases
-- https://bit.ly/28Rpb2x
-- Returns a list of all global trace flags that are enabled (Query 5) (Global Trace Flags)
DBCC TRACESTATUS (-1);
------
-- If no global trace flags are enabled, no results will be returned.
-- It is very useful to know what global trace flags are currently enabled as part of the diagnostic process.
-- Common trace flags that should be enabled in most cases
-- TF 3226 - Supresses logging of successful database backup messages to the SQL Server Error Log
-- https://bit.ly/2p6MTjS
-- TF 6534 - Enables use of native code to improve performance with spatial data
-- https://bit.ly/2HrQUpU
-- The behavior of TF 1117, 1118 are enabled for tempdb in SQL Server 2016 by default
-- SQL 2016 � It Just Runs Faster: -T1117 and -T1118 changes for TEMPDB and user databases
-- https://bit.ly/2lbNWxK
-- The behavior of TF 2371 is enabled by default in SQL Server 2016 and newer (in compat level 130 and higher)
-- DBCC TRACEON - Trace Flags (Transact-SQL)
-- https://bit.ly/2FuSvPg
-- Returns status of instant file initialization (Query 6) (IFI Status)
EXEC sys.xp_readerrorlog 0, 1, N'Database Instant File Initialization';
------
-- Lets you determine whether Instant File Initialization (IFI) is enabled for the instance
-- This should be enabled in the vast majority of cases
-- SQL Server 2016 lets you enable this during the SQL server installation process
-- Database Instant File Initialization
-- https://bit.ly/2nTX74y
-- Misconceptions around instant file initialization
-- https://bit.ly/2oBSKgZ
-- SQL Server Process Address space info (Query 7) (Process Memory)
-- (shows whether locked pages is enabled, among other things)
SELECT physical_memory_in_use_kb/1024 AS [SQL Server Memory Usage (MB)],
locked_page_allocations_kb/1024 AS [SQL Server Locked Pages Allocation (MB)],
large_page_allocations_kb/1024 AS [SQL Server Large Pages Allocation (MB)],
page_fault_count, memory_utilization_percentage, available_commit_limit_kb,
process_physical_memory_low, process_virtual_memory_low
FROM sys.dm_os_process_memory WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You want to see 0 for process_physical_memory_low
-- You want to see 0 for process_virtual_memory_low
-- This indicates that you are not under internal memory pressure
-- If locked_page_allocations_kb > 0, then LPIM is enabled
-- How to enable the "locked pages" feature in SQL Server 2012
-- https://bit.ly/2F5UjOA
-- Memory Management Architecture Guide
-- https://bit.ly/2JKkadC
-- SQL Server Services information (Query 8) (SQL Server Services Info)
SELECT servicename, process_id, startup_type_desc, status_desc,
last_startup_time, service_account, is_clustered, cluster_nodename, [filename],
instant_file_initialization_enabled -- New in SQL Server 2016 SP1
FROM sys.dm_server_services WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Tells you the account being used for the SQL Server Service and the SQL Agent Service
-- Shows the process_id, when they were last started, and their current status
-- Also shows whether you are running on a failover cluster instance, and what node you are running on
-- Also shows whether IFI is enabled
-- sys.dm_server_services (Transact-SQL)
-- https://bit.ly/2oKa1Un
-- Last backup information by database (Query 9) (Last Backup By Database)
SELECT ISNULL(d.[name], bs.[database_name]) AS [Database], d.recovery_model_desc AS [Recovery Model],
d.log_reuse_wait_desc AS [Log Reuse Wait Desc],
MAX(CASE WHEN [type] = 'D' THEN bs.backup_finish_date ELSE NULL END) AS [Last Full Backup],
MAX(CASE WHEN [type] = 'I' THEN bs.backup_finish_date ELSE NULL END) AS [Last Differential Backup],
MAX(CASE WHEN [type] = 'L' THEN bs.backup_finish_date ELSE NULL END) AS [Last Log Backup]
FROM sys.databases AS d WITH (NOLOCK)
LEFT OUTER JOIN msdb.dbo.backupset AS bs WITH (NOLOCK)
ON bs.[database_name] = d.[name]
AND bs.backup_finish_date > GETDATE()- 30
WHERE d.name <> N'tempdb'
GROUP BY ISNULL(d.[name], bs.[database_name]), d.recovery_model_desc, d.log_reuse_wait_desc, d.[name]
ORDER BY d.recovery_model_desc, d.[name] OPTION (RECOMPILE);
------
-- This helps you spot runaway transaction logs and other issues with your backup schedule
-- Get SQL Server Agent jobs and Category information (Query 10) (SQL Server Agent Jobs)
SELECT sj.name AS [Job Name], sj.[description] AS [Job Description], SUSER_SNAME(sj.owner_sid) AS [Job Owner],
sj.date_created AS [Date Created], sj.[enabled] AS [Job Enabled],
sj.notify_email_operator_id, sj.notify_level_email, sc.name AS [CategoryName],
s.[enabled] AS [Sched Enabled], js.next_run_date, js.next_run_time
FROM msdb.dbo.sysjobs AS sj WITH (NOLOCK)
INNER JOIN msdb.dbo.syscategories AS sc WITH (NOLOCK)
ON sj.category_id = sc.category_id
LEFT OUTER JOIN msdb.dbo.sysjobschedules AS js WITH (NOLOCK)
ON sj.job_id = js.job_id
LEFT OUTER JOIN msdb.dbo.sysschedules AS s WITH (NOLOCK)
ON js.schedule_id = s.schedule_id
ORDER BY sj.name OPTION (RECOMPILE);
------
-- Gives you some basic information about your SQL Server Agent jobs, who owns them and how they are configured
-- Look for Agent jobs that are not owned by sa
-- Look for jobs that have a notify_email_operator_id set to 0 (meaning no operator)
-- Look for jobs that have a notify_level_email set to 0 (meaning no e-mail is ever sent)
--
-- MSDN sysjobs documentation
-- https://bit.ly/2paDEOP
-- SQL Server Maintenance Solution
-- https://bit.ly/1pgchQu
-- Get SQL Server Agent Alert Information (Query 11) (SQL Server Agent Alerts)
SELECT name, event_source, message_id, severity, [enabled], has_notification,
delay_between_responses, occurrence_count, last_occurrence_date, last_occurrence_time
FROM msdb.dbo.sysalerts WITH (NOLOCK)
ORDER BY name OPTION (RECOMPILE);
------
-- Gives you some basic information about your SQL Server Agent Alerts
-- (which are different from SQL Server Agent jobs)
-- Read more about Agent Alerts here: https://bit.ly/2Giz0Xf
-- Windows information (Query 12) (Windows Info)
SELECT windows_release, windows_service_pack_level,
windows_sku, os_language_version
FROM sys.dm_os_windows_info WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Gives you major OS version, Service Pack, Edition, and language info for the operating system
-- 10.0 is either Windows 10 or Windows Server 2016
-- 6.3 is either Windows 8.1 or Windows Server 2012 R2
-- 6.2 is either Windows 8 or Windows Server 2012
-- Windows SKU codes
-- 4 is Enterprise Edition
-- 7 is Standard Server Edition
-- 8 is Datacenter Server Edition
-- 10 is Enterprise Server Edition
-- 48 is Professional Edition
-- 161 is Pro for Workstations
-- 1033 for os_language_version is US-English
-- SQL Server 2016 requires Windows Server 2012 or newer
-- Quick-Start Installation of SQL Server 2016
-- https://bit.ly/2qtxQ3G
-- Hardware and Software Requirements for Installing SQL Server 2016
-- https://bit.ly/2JJIUTl
-- Using SQL Server in Windows 8 and later versions of Windows operating system
-- https://bit.ly/2F7Ax0P
-- SQL Server NUMA Node information (Query 13) (SQL Server NUMA Info)
SELECT node_id, node_state_desc, memory_node_id, processor_group, online_scheduler_count,
idle_scheduler_count, active_worker_count, avg_load_balance, resource_monitor_state
FROM sys.dm_os_nodes WITH (NOLOCK)
WHERE node_state_desc <> N'ONLINE DAC' OPTION (RECOMPILE);
------
-- Gives you some useful information about the composition and relative load on your NUMA nodes
-- You want to see an equal number of schedulers on each NUMA node
-- Watch out if SQL Server 2016 Standard Edition has been installed
-- on a physical or virtual machine with more than four sockets or more than 24 physical cores
-- sys.dm_os_nodes (Transact-SQL)
-- https://bit.ly/2pn5Mw8
-- Balancing Your Available SQL Server Core Licenses Evenly Across NUMA Nodes
-- https://bit.ly/2vfC4Rq
-- Good basic information about OS memory amounts and state (Query 14) (System Memory)
SELECT total_physical_memory_kb/1024 AS [Physical Memory (MB)],
available_physical_memory_kb/1024 AS [Available Memory (MB)],
total_page_file_kb/1024 AS [Total Page File (MB)],
available_page_file_kb/1024 AS [Available Page File (MB)],
system_cache_kb/1024 AS [System Cache (MB)],
system_memory_state_desc AS [System Memory State]
FROM sys.dm_os_sys_memory WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You want to see "Available physical memory is high" for System Memory State
-- This indicates that you are not under external memory pressure
-- Possible System Memory State values:
-- Available physical memory is high
-- Physical memory usage is steady
-- Available physical memory is low
-- Available physical memory is running low
-- Physical memory state is transitioning
-- sys.dm_os_sys_memory (Transact-SQL)
-- https://bit.ly/2pcV0xq
-- You can skip the next two queries if you know you don't have a clustered instance
-- Get information about your cluster nodes and their status (Query 15) (Cluster Node Properties)
-- (if your database server is in a failover cluster)
SELECT NodeName, status_description, is_current_owner
FROM sys.dm_os_cluster_nodes WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Knowing which node owns the cluster resources is critical
-- Especially when you are installing Windows or SQL Server updates
-- You will see no results if your instance is not clustered
-- Recommended hotfixes and updates for Windows Server 2012 R2-based failover clusters
-- https://bit.ly/1z5BfCw
-- Get information about any AlwaysOn AG cluster this instance is a part of (Query 16) (AlwaysOn AG Cluster)
SELECT cluster_name, quorum_type_desc, quorum_state_desc
FROM sys.dm_hadr_cluster WITH (NOLOCK) OPTION (RECOMPILE);
------
-- You will see no results if your instance is not using AlwaysOn AGs
-- Good overview of AG health and status (Query 17) (AlwaysOn AG Status)
SELECT ag.name AS [AG Name], ar.replica_server_name, ar.availability_mode_desc, adc.[database_name],
drs.is_local, drs.is_primary_replica, drs.synchronization_state_desc, drs.is_commit_participant,
drs.synchronization_health_desc, drs.recovery_lsn, drs.truncation_lsn, drs.last_sent_lsn,
drs.last_sent_time, drs.last_received_lsn, drs.last_received_time, drs.last_hardened_lsn,
drs.last_hardened_time, drs.last_redone_lsn, drs.last_redone_time, drs.log_send_queue_size,
drs.log_send_rate, drs.redo_queue_size, drs.redo_rate, drs.filestream_send_rate,
drs.end_of_log_lsn, drs.last_commit_lsn, drs.last_commit_time, drs.database_state_desc
FROM sys.dm_hadr_database_replica_states AS drs WITH (NOLOCK)
INNER JOIN sys.availability_databases_cluster AS adc WITH (NOLOCK)
ON drs.group_id = adc.group_id
AND drs.group_database_id = adc.group_database_id
INNER JOIN sys.availability_groups AS ag WITH (NOLOCK)
ON ag.group_id = drs.group_id
INNER JOIN sys.availability_replicas AS ar WITH (NOLOCK)
ON drs.group_id = ar.group_id
AND drs.replica_id = ar.replica_id
ORDER BY ag.name, ar.replica_server_name, adc.[database_name] OPTION (RECOMPILE);
-- You will see no results if your instance is not using AlwaysOn AGs
-- SQL Server 2016 � It Just Runs Faster: Always On Availability Groups Turbocharged
-- https://bit.ly/2dn1H6r
-- Hardware information from SQL Server 2016 (Query 18) (Hardware Info)
SELECT cpu_count AS [Logical CPU Count], scheduler_count,
hyperthread_ratio AS [Hyperthread Ratio],
cpu_count/hyperthread_ratio AS [Physical CPU Count],
physical_memory_kb/1024 AS [Physical Memory (MB)],
committed_kb/1024 AS [Committed Memory (MB)],
committed_target_kb/1024 AS [Committed Target Memory (MB)],
max_workers_count AS [Max Workers Count],
affinity_type_desc AS [Affinity Type],
sqlserver_start_time AS [SQL Server Start Time],
virtual_machine_type_desc AS [Virtual Machine Type],
softnuma_configuration_desc AS [Soft NUMA Configuration],
sql_memory_model_desc -- New in SQL Server 2016
FROM sys.dm_os_sys_info WITH (NOLOCK) OPTION (RECOMPILE);
------
-- Gives you some good basic hardware information about your database server
-- Note: virtual_machine_type_desc of HYPERVISOR does not automatically mean you are running SQL Server inside of a VM
-- It merely indicates that you have a hypervisor running on your host
-- sys.dm_os_sys_info (Transact-SQL)
-- https://bit.ly/2pczOYs
-- Soft NUMA configuration was a new column for SQL Server 2016
-- OFF = Soft-NUMA feature is OFF
-- ON = SQL Server automatically determines the NUMA node sizes for Soft-NUMA
-- MANUAL = Manually configured soft-NUMA
-- Configure SQL Server to Use Soft-NUMA (SQL Server)
-- https://bit.ly/2HTpKJt
-- sql_memory_model_desc values (Added in SQL Server 2016 SP1)
-- CONVENTIONAL
-- LOCK_PAGES
-- LARGE_PAGES
-- Get System Manufacturer and model number from SQL Server Error log (Query 19) (System Manufacturer)
EXEC sys.xp_readerrorlog 0, 1, N'Manufacturer';
------
-- This can help you determine the capabilities and capacities of your database server
-- Can also be used to confirm if you are running in a VM
-- This query might take a few seconds if you have not recycled your error log recently
-- This query will return no results if your error log has been recycled since the instance was started
-- Get BIOS date from Windows Registry (Query 20) (BIOS Date)
EXEC sys.xp_instance_regread N'HKEY_LOCAL_MACHINE', N'HARDWARE\DESCRIPTION\System\BIOS', N'BiosReleaseDate';
------
-- Helps you understand whether the main system BIOS is up to date, and the possible age of the hardware
-- Not as useful for virtualization
-- Get processor description from Windows Registry (Query 21) (Processor Description)
EXEC sys.xp_instance_regread N'HKEY_LOCAL_MACHINE', N'HARDWARE\DESCRIPTION\System\CentralProcessor\0', N'ProcessorNameString';
------
-- Gives you the model number and rated clock speed of your processor(s)
-- Your processors may be running at less than the rated clock speed due
-- to the Windows Power Plan or hardware power management
-- You can use CPU-Z to get your actual CPU core speed and a lot of other useful information
-- https://bit.ly/QhR6xF
-- You can learn more about processor selection for SQL Server by following this link
-- https://bit.ly/2F3aVlP
-- See if buffer pool extension (BPE) is enabled (Query 22) (BPE Configuration)
SELECT [path], state_description, current_size_in_kb,
CAST(current_size_in_kb/1048576.0 AS DECIMAL(10,2)) AS [Size (GB)]
FROM sys.dm_os_buffer_pool_extension_configuration WITH (NOLOCK) OPTION (RECOMPILE);
------
-- BPE is available in both Standard Edition and Enterprise Edition
-- It is a more interesting feature for Standard Edition
-- Buffer Pool Extension to SSDs in SQL Server 2014
-- https://bit.ly/1bm08m8
-- Buffer Pool Extension
-- https://bit.ly/2oBuieO
-- Look at buffer descriptors to see BPE usage by database (Query 23) (BPE Usage)
SELECT DB_NAME(database_id) AS [Database Name], COUNT(page_id) AS [Page Count],
CAST(COUNT(*)/128.0 AS DECIMAL(10, 2)) AS [Buffer size(MB)],
AVG(read_microsec) AS [Avg Read Time (microseconds)]
FROM sys.dm_os_buffer_descriptors WITH (NOLOCK)
WHERE database_id <> 32767
AND is_in_bpool_extension = 1
GROUP BY DB_NAME(database_id)
ORDER BY [Buffer size(MB)] DESC OPTION (RECOMPILE);
------
-- You will see no results if BPE is not enabled or if there is no BPE usage
-- Get information on location, time and size of any memory dumps from SQL Server (Query 24) (Memory Dump Info)
SELECT [filename], creation_time, size_in_bytes/1048576.0 AS [Size (MB)]
FROM sys.dm_server_memory_dumps WITH (NOLOCK)
ORDER BY creation_time DESC OPTION (RECOMPILE);
------
-- This will not return any rows if you have
-- not had any memory dumps (which is a good thing)
-- sys.dm_server_memory_dumps (Transact-SQL)
-- https://bit.ly/2elwWll
-- Look at Suspect Pages table (Query 25) (Suspect Pages)
SELECT DB_NAME(database_id) AS [Database Name], [file_id], page_id,
event_type, error_count, last_update_date
FROM msdb.dbo.suspect_pages WITH (NOLOCK)
ORDER BY database_id OPTION (RECOMPILE);
------
-- event_type value descriptions
-- 1 = 823 error caused by an operating system CRC error
-- or 824 error other than a bad checksum or a torn page (for example, a bad page ID)
-- 2 = Bad checksum
-- 3 = Torn page
-- 4 = Restored (The page was restored after it was marked bad)
-- 5 = Repaired (DBCC repaired the page)
-- 7 = Deallocated by DBCC
-- Ideally, this query returns no results. The table is limited to 1000 rows.
-- If you do get results here, you should do further investigation to determine the root cause
-- Manage the suspect_pages Table
-- https://bit.ly/2Fvr1c9
-- Get number of data files in tempdb database (Query 26) (TempDB Data Files)
EXEC sys.xp_readerrorlog 0, 1, N'The tempdb database has';
------
-- Get the number of data files in the tempdb database
-- 4-8 data files that are all the same size is a good starting point
-- This query will return no results if your error log has been recycled since the instance was last started
-- File names and paths for all user and system databases on instance (Query 27) (Database Filenames and Paths)
SELECT DB_NAME([database_id]) AS [Database Name],
[file_id], [name], physical_name, [type_desc], state_desc,
is_percent_growth, growth,
CONVERT(bigint, growth/128.0) AS [Growth in MB],
CONVERT(bigint, size/128.0) AS [Total Size in MB]
FROM sys.master_files WITH (NOLOCK)
ORDER BY DB_NAME([database_id]), [file_id] OPTION (RECOMPILE);
------
-- Things to look at:
-- Are data files and log files on different drives?
-- Is everything on the C: drive?
-- Is tempdb on dedicated drives?
-- Is there only one tempdb data file?
-- Are all of the tempdb data files the same size?
-- Are there multiple data files for user databases?
-- Is percent growth enabled for any files (which is bad)?
-- Volume info for all LUNS that have database files on the current instance (Query 28) (Volume Info)
SELECT DISTINCT vs.volume_mount_point, vs.file_system_type, vs.logical_volume_name,
CONVERT(DECIMAL(18,2), vs.total_bytes/1073741824.0) AS [Total Size (GB)],
CONVERT(DECIMAL(18,2), vs.available_bytes/1073741824.0) AS [Available Size (GB)],
CONVERT(DECIMAL(18,2), vs.available_bytes * 1. / vs.total_bytes * 100.) AS [Space Free %],
vs.supports_compression, vs.is_compressed,
vs.supports_sparse_files, vs.supports_alternate_streams
FROM sys.master_files AS f WITH (NOLOCK)
CROSS APPLY sys.dm_os_volume_stats(f.database_id, f.[file_id]) AS vs
ORDER BY vs.volume_mount_point OPTION (RECOMPILE);
------
-- Shows you the total and free space on the LUNs where you have database files
-- Being low on free space can negatively affect performance
-- sys.dm_os_volume_stats (Transact-SQL)
-- https://bit.ly/2oBPNNr
-- Drive level latency information (Query 29) (Drive Level Latency)
-- Based on code from Jimmy May
SELECT tab.[Drive], tab.volume_mount_point AS [Volume Mount Point],
CASE
WHEN num_of_reads = 0 THEN 0
ELSE (io_stall_read_ms/num_of_reads)
END AS [Read Latency],
CASE
WHEN num_of_writes = 0 THEN 0
ELSE (io_stall_write_ms/num_of_writes)
END AS [Write Latency],
CASE
WHEN (num_of_reads = 0 AND num_of_writes = 0) THEN 0
ELSE (io_stall/(num_of_reads + num_of_writes))
END AS [Overall Latency],
CASE
WHEN num_of_reads = 0 THEN 0
ELSE (num_of_bytes_read/num_of_reads)
END AS [Avg Bytes/Read],
CASE
WHEN num_of_writes = 0 THEN 0
ELSE (num_of_bytes_written/num_of_writes)
END AS [Avg Bytes/Write],
CASE
WHEN (num_of_reads = 0 AND num_of_writes = 0) THEN 0
ELSE ((num_of_bytes_read + num_of_bytes_written)/(num_of_reads + num_of_writes))
END AS [Avg Bytes/Transfer]
FROM (SELECT LEFT(UPPER(mf.physical_name), 2) AS Drive, SUM(num_of_reads) AS num_of_reads,
SUM(io_stall_read_ms) AS io_stall_read_ms, SUM(num_of_writes) AS num_of_writes,
SUM(io_stall_write_ms) AS io_stall_write_ms, SUM(num_of_bytes_read) AS num_of_bytes_read,
SUM(num_of_bytes_written) AS num_of_bytes_written, SUM(io_stall) AS io_stall, vs.volume_mount_point
FROM sys.dm_io_virtual_file_stats(NULL, NULL) AS vfs
INNER JOIN sys.master_files AS mf WITH (NOLOCK)
ON vfs.database_id = mf.database_id AND vfs.file_id = mf.file_id
CROSS APPLY sys.dm_os_volume_stats(mf.database_id, mf.[file_id]) AS vs
GROUP BY LEFT(UPPER(mf.physical_name), 2), vs.volume_mount_point) AS tab
ORDER BY [Overall Latency] OPTION (RECOMPILE);
------
-- Shows you the drive-level latency for reads and writes, in milliseconds
-- Latency above 30-40ms is usually a problem
-- These latency numbers include all file activity against all SQL Server
-- database files on each drive since SQL Server was last started
-- Calculates average stalls per read, per write, and per total input/output for each database file (Query 30) (IO Stalls by File)
SELECT DB_NAME(fs.database_id) AS [Database Name], CAST(fs.io_stall_read_ms/(1.0 + fs.num_of_reads) AS NUMERIC(10,1)) AS [avg_read_stall_ms],
CAST(fs.io_stall_write_ms/(1.0 + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_write_stall_ms],
CAST((fs.io_stall_read_ms + fs.io_stall_write_ms)/(1.0 + fs.num_of_reads + fs.num_of_writes) AS NUMERIC(10,1)) AS [avg_io_stall_ms],
CONVERT(DECIMAL(18,2), mf.size/128.0) AS [File Size (MB)], mf.physical_name, mf.type_desc, fs.io_stall_read_ms, fs.num_of_reads,
fs.io_stall_write_ms, fs.num_of_writes, fs.io_stall_read_ms + fs.io_stall_write_ms AS [io_stalls], fs.num_of_reads + fs.num_of_writes AS [total_io],
io_stall_queued_read_ms AS [Resource Governor Total Read IO Latency (ms)], io_stall_queued_write_ms AS [Resource Governor Total Write IO Latency (ms)]
FROM sys.dm_io_virtual_file_stats(null,null) AS fs
INNER JOIN sys.master_files AS mf WITH (NOLOCK)
ON fs.database_id = mf.database_id
AND fs.[file_id] = mf.[file_id]
ORDER BY avg_io_stall_ms DESC OPTION (RECOMPILE);
------
-- Helps determine which database files on the entire instance have the most I/O bottlenecks
-- This can help you decide whether certain LUNs are overloaded and whether you might
-- want to move some files to a different location or perhaps improve your I/O performance
-- These latency numbers include all file activity against each SQL Server
-- database file since SQL Server was last started
-- Look for I/O requests taking longer than 15 seconds in the six most recent SQL Server Error Logs (Query 31) (IO Warnings)
CREATE TABLE #IOWarningResults(LogDate datetime, ProcessInfo sysname, LogText nvarchar(1000));
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 0, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 1, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 2, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 3, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 4, 1, N'taking longer than 15 seconds';
INSERT INTO #IOWarningResults
EXEC xp_readerrorlog 5, 1, N'taking longer than 15 seconds';
SELECT LogDate, ProcessInfo, LogText
FROM #IOWarningResults
ORDER BY LogDate DESC;
DROP TABLE #IOWarningResults;
------
-- Finding 15 second I/O warnings in the SQL Server Error Log is useful evidence of
-- poor I/O performance (which might have many different causes)
-- Look to see if you see any patterns in the results (same files, same drives, same time of day, etc.)
-- Diagnostics in SQL Server help detect stalled and stuck I/O operations
-- https://bit.ly/2qtaw73
-- Recovery model, log reuse wait description, log file size, log usage size (Query 32) (Database Properties)
-- and compatibility level for all databases on instance
SELECT db.[name] AS [Database Name], SUSER_SNAME(db.owner_sid) AS [Database Owner], db.recovery_model_desc AS [Recovery Model],
db.state_desc, db.containment_desc, db.log_reuse_wait_desc AS [Log Reuse Wait Description],
CONVERT(DECIMAL(18,2), ls.cntr_value/1024.0) AS [Log Size (MB)], CONVERT(DECIMAL(18,2), lu.cntr_value/1024.0) AS [Log Used (MB)],
CAST(CAST(lu.cntr_value AS FLOAT) / CAST(ls.cntr_value AS FLOAT)AS DECIMAL(18,2)) * 100 AS [Log Used %],
db.[compatibility_level] AS [DB Compatibility Level],
db.is_mixed_page_allocation_on, db.page_verify_option_desc AS [Page Verify Option],
db.is_auto_create_stats_on, db.is_auto_update_stats_on, db.is_auto_update_stats_async_on, db.is_parameterization_forced,
db.snapshot_isolation_state_desc, db.is_read_committed_snapshot_on, db.is_auto_close_on, db.is_auto_shrink_on,
db.target_recovery_time_in_seconds, db.is_cdc_enabled, db.is_published, db.is_distributor, db.is_encrypted,
db.group_database_id, db.replica_id,db.is_memory_optimized_elevate_to_snapshot_on,
db.delayed_durability_desc, db.is_auto_create_stats_incremental_on,
db.is_query_store_on, db.is_sync_with_backup,
db.is_supplemental_logging_enabled, db.is_remote_data_archive_enabled,
db.is_encrypted, de.encryption_state, de.percent_complete, de.key_algorithm, de.key_length
FROM sys.databases AS db WITH (NOLOCK)
INNER JOIN sys.dm_os_performance_counters AS lu WITH (NOLOCK)
ON db.name = lu.instance_name
INNER JOIN sys.dm_os_performance_counters AS ls WITH (NOLOCK)
ON db.name = ls.instance_name
LEFT OUTER JOIN sys.dm_database_encryption_keys AS de WITH (NOLOCK)
ON db.database_id = de.database_id
WHERE lu.counter_name LIKE N'Log File(s) Used Size (KB)%'
AND ls.counter_name LIKE N'Log File(s) Size (KB)%'
AND ls.cntr_value > 0
ORDER BY db.[name] OPTION (RECOMPILE);
------
-- Things to look at:
-- How many databases are on the instance?
-- What recovery models are they using?
-- What is the log reuse wait description?
-- How full are the transaction logs?
-- What compatibility level are the databases on?
-- What is the Page Verify Option? (should be CHECKSUM)
-- Is Auto Update Statistics Asynchronously enabled?
-- Is Delayed Durability enabled
-- Make sure auto_shrink and auto_close are not enabled!
-- is_mixed_page_allocation_on is a new property for SQL Server 2016. Equivalent to TF 1118 for a user database
-- SQL Server 2016: Changes in default behavior for autogrow and allocations for tempdb and user databases
-- https://bit.ly/2evRZSR
-- A non-zero value for target_recovery_time_in_seconds means that indirect checkpoint is enabled
-- If the setting has a zero value it indicates that automatic checkpoint is enabled
-- Changes in SQL Server 2016 Checkpoint Behavior
-- https://bit.ly/2pdggk3
-- Missing Indexes for all databases by Index Advantage (Query 33) (Missing Indexes All Databases)
SELECT CONVERT(decimal(18,2), user_seeks * avg_total_user_cost * (avg_user_impact * 0.01)) AS [index_advantage],
FORMAT(migs.last_user_seek, 'yyyy-MM-dd HH:mm:ss') AS [last_user_seek],
mid.[statement] AS [Database.Schema.Table],
COUNT(1) OVER(PARTITION BY mid.[statement]) AS [missing_indexes_for_table],
COUNT(1) OVER(PARTITION BY mid.[statement], equality_columns) AS [similar_missing_indexes_for_table],
mid.equality_columns, mid.inequality_columns, mid.included_columns,
migs.unique_compiles, migs.user_seeks,
CONVERT(decimal(18,2), migs.avg_total_user_cost) AS [avg_total_user_cost], migs.avg_user_impact
FROM sys.dm_db_missing_index_group_stats AS migs WITH (NOLOCK)
INNER JOIN sys.dm_db_missing_index_groups AS mig WITH (NOLOCK)
ON migs.group_handle = mig.index_group_handle
INNER JOIN sys.dm_db_missing_index_details AS mid WITH (NOLOCK)
ON mig.index_handle = mid.index_handle
ORDER BY index_advantage DESC OPTION (RECOMPILE);
------
-- Getting missing index information for all of the databases on the instance is very useful
-- Look at last user seek time, number of user seeks to help determine source and importance
-- Also look at avg_user_impact and avg_total_user_cost to help determine importance
-- SQL Server is overly eager to add included columns, so beware
-- Do not just blindly add indexes that show up from this query!!!
-- SQL Server Index Design Guide
-- https://bit.ly/2qtZr4N
-- Get VLF Counts for all databases on the instance (Query 34) (VLF Counts)
-- (adapted from Michelle Ufford)
CREATE TABLE #VLFInfo (RecoveryUnitID int, FileID int,
FileSize bigint, StartOffset bigint,
FSeqNo bigint, [Status] bigint,
Parity bigint, CreateLSN numeric(38));
CREATE TABLE #VLFCountResults(DatabaseName sysname, VLFCount int);
EXEC sp_MSforeachdb N'Use [?];
INSERT INTO #VLFInfo
EXEC sp_executesql N''DBCC LOGINFO([?])'';
INSERT INTO #VLFCountResults
SELECT DB_NAME(), COUNT(*)
FROM #VLFInfo;
TRUNCATE TABLE #VLFInfo;'
SELECT DatabaseName, VLFCount
FROM #VLFCountResults
ORDER BY VLFCount DESC;
DROP TABLE #VLFInfo;
DROP TABLE #VLFCountResults;
------
-- High VLF counts can affect write performance to the log file
-- and they can make full database restores and crash recovery take much longer
-- Try to keep your VLF counts under 200 in most cases (depending on log file size)
-- Important change to VLF creation algorithm in SQL Server 2014
-- https://bit.ly/2Hsjbg4
-- SQL Server Transaction Log Architecture and Management Guide
-- https://bit.ly/2JjmQRZ
-- Get CPU utilization by database (Query 35) (CPU Usage by Database)
WITH DB_CPU_Stats
AS
(SELECT pa.DatabaseID, DB_Name(pa.DatabaseID) AS [Database Name], SUM(qs.total_worker_time/1000) AS [CPU_Time_Ms]
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY (SELECT CONVERT(int, value) AS [DatabaseID]
FROM sys.dm_exec_plan_attributes(qs.plan_handle)
WHERE attribute = N'dbid') AS pa
GROUP BY DatabaseID)
SELECT ROW_NUMBER() OVER(ORDER BY [CPU_Time_Ms] DESC) AS [CPU Rank],
[Database Name], [CPU_Time_Ms] AS [CPU Time (ms)],
CAST([CPU_Time_Ms] * 1.0 / SUM([CPU_Time_Ms]) OVER() * 100.0 AS DECIMAL(5, 2)) AS [CPU Percent]
FROM DB_CPU_Stats
WHERE DatabaseID <> 32767 -- ResourceDB
ORDER BY [CPU Rank] OPTION (RECOMPILE);
------
-- Helps determine which database is using the most CPU resources on the instance
-- Get I/O utilization by database (Query 36) (IO Usage By Database)
WITH Aggregate_IO_Statistics
AS (SELECT DB_NAME(database_id) AS [Database Name],
CAST(SUM(num_of_bytes_read + num_of_bytes_written) / 1048576 AS DECIMAL(12, 2)) AS [ioTotalMB],
CAST(SUM(num_of_bytes_read ) / 1048576 AS DECIMAL(12, 2)) AS [ioReadMB],
CAST(SUM(num_of_bytes_written) / 1048576 AS DECIMAL(12, 2)) AS [ioWriteMB]
FROM sys.dm_io_virtual_file_stats(NULL, NULL) AS [DM_IO_STATS]
GROUP BY database_id)
SELECT ROW_NUMBER() OVER (ORDER BY ioTotalMB DESC) AS [I/O Rank],
[Database Name], ioTotalMB AS [Total I/O (MB)],
CAST(ioTotalMB / SUM(ioTotalMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Total I/O %],
ioReadMB AS [Read I/O (MB)],
CAST(ioReadMB / SUM(ioReadMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Read I/O %],
ioWriteMB AS [Write I/O (MB)],
CAST(ioWriteMB / SUM(ioWriteMB) OVER () * 100.0 AS DECIMAL(5, 2)) AS [Write I/O %]
FROM Aggregate_IO_Statistics
ORDER BY [I/O Rank] OPTION (RECOMPILE);
------
-- Helps determine which database is using the most I/O resources on the instance
-- These numbers are cumulative since the last service restart
-- They include all I/O activity, not just the nominal I/O workload
-- Get total buffer usage by database for current instance (Query 37) (Total Buffer Usage by Database)
-- This make take some time to run on a busy instance
WITH AggregateBufferPoolUsage
AS
(SELECT DB_NAME(database_id) AS [Database Name],
CAST(COUNT(*) * 8/1024.0 AS DECIMAL (10,2)) AS [CachedSize]
FROM sys.dm_os_buffer_descriptors WITH (NOLOCK)
WHERE database_id <> 32767 -- ResourceDB
GROUP BY DB_NAME(database_id))
SELECT ROW_NUMBER() OVER(ORDER BY CachedSize DESC) AS [Buffer Pool Rank], [Database Name], CachedSize AS [Cached Size (MB)],
CAST(CachedSize / SUM(CachedSize) OVER() * 100.0 AS DECIMAL(5,2)) AS [Buffer Pool Percent]
FROM AggregateBufferPoolUsage
ORDER BY [Buffer Pool Rank] OPTION (RECOMPILE);
------
-- Tells you how much memory (in the buffer pool)
-- is being used by each database on the instance
-- Clear Wait Stats with this command
-- DBCC SQLPERF('sys.dm_os_wait_stats', CLEAR);
-- Isolate top waits for server instance since last restart or wait statistics clear (Query 38) (Top Waits)
WITH [Waits]
AS (SELECT wait_type, wait_time_ms/ 1000.0 AS [WaitS],
(wait_time_ms - signal_wait_time_ms) / 1000.0 AS [ResourceS],
signal_wait_time_ms / 1000.0 AS [SignalS],
waiting_tasks_count AS [WaitCount],
100.0 * wait_time_ms / SUM (wait_time_ms) OVER() AS [Percentage],
ROW_NUMBER() OVER(ORDER BY wait_time_ms DESC) AS [RowNum]
FROM sys.dm_os_wait_stats WITH (NOLOCK)
WHERE [wait_type] NOT IN (
N'BROKER_EVENTHANDLER', N'BROKER_RECEIVE_WAITFOR', N'BROKER_TASK_STOP',
N'BROKER_TO_FLUSH', N'BROKER_TRANSMITTER', N'CHECKPOINT_QUEUE',
N'CHKPT', N'CLR_AUTO_EVENT', N'CLR_MANUAL_EVENT', N'CLR_SEMAPHORE',
N'DBMIRROR_DBM_EVENT', N'DBMIRROR_EVENTS_QUEUE', N'DBMIRROR_WORKER_QUEUE',
N'DBMIRRORING_CMD', N'DIRTY_PAGE_POLL', N'DISPATCHER_QUEUE_SEMAPHORE',
N'EXECSYNC', N'FSAGENT', N'FT_IFTS_SCHEDULER_IDLE_WAIT', N'FT_IFTSHC_MUTEX',
N'HADR_CLUSAPI_CALL', N'HADR_FILESTREAM_IOMGR_IOCOMPLETION', N'HADR_LOGCAPTURE_WAIT',
N'HADR_NOTIFICATION_DEQUEUE', N'HADR_TIMER_TASK', N'HADR_WORK_QUEUE',
N'KSOURCE_WAKEUP', N'LAZYWRITER_SLEEP', N'LOGMGR_QUEUE',
N'MEMORY_ALLOCATION_EXT', N'ONDEMAND_TASK_QUEUE',
N'PARALLEL_REDO_DRAIN_WORKER', N'PARALLEL_REDO_LOG_CACHE', N'PARALLEL_REDO_TRAN_LIST',
N'PARALLEL_REDO_WORKER_SYNC', N'PARALLEL_REDO_WORKER_WAIT_WORK',
N'PREEMPTIVE_HADR_LEASE_MECHANISM', N'PREEMPTIVE_SP_SERVER_DIAGNOSTICS',
N'PREEMPTIVE_OS_LIBRARYOPS', N'PREEMPTIVE_OS_COMOPS', N'PREEMPTIVE_OS_CRYPTOPS',
N'PREEMPTIVE_OS_PIPEOPS', N'PREEMPTIVE_OS_AUTHENTICATIONOPS',
N'PREEMPTIVE_OS_GENERICOPS', N'PREEMPTIVE_OS_VERIFYTRUST',
N'PREEMPTIVE_OS_FILEOPS', N'PREEMPTIVE_OS_DEVICEOPS', N'PREEMPTIVE_OS_QUERYREGISTRY',
N'PREEMPTIVE_OS_WRITEFILE',
N'PREEMPTIVE_XE_CALLBACKEXECUTE', N'PREEMPTIVE_XE_DISPATCHER',
N'PREEMPTIVE_XE_GETTARGETSTATE', N'PREEMPTIVE_XE_SESSIONCOMMIT',
N'PREEMPTIVE_XE_TARGETINIT', N'PREEMPTIVE_XE_TARGETFINALIZE',
N'PWAIT_ALL_COMPONENTS_INITIALIZED', N'PWAIT_DIRECTLOGCONSUMER_GETNEXT',
N'QDS_PERSIST_TASK_MAIN_LOOP_SLEEP',
N'QDS_ASYNC_QUEUE',
N'QDS_CLEANUP_STALE_QUERIES_TASK_MAIN_LOOP_SLEEP', N'REQUEST_FOR_DEADLOCK_SEARCH',
N'RESOURCE_QUEUE', N'SERVER_IDLE_CHECK', N'SLEEP_BPOOL_FLUSH', N'SLEEP_DBSTARTUP',
N'SLEEP_DCOMSTARTUP', N'SLEEP_MASTERDBREADY', N'SLEEP_MASTERMDREADY',
N'SLEEP_MASTERUPGRADED', N'SLEEP_MSDBSTARTUP', N'SLEEP_SYSTEMTASK', N'SLEEP_TASK',
N'SLEEP_TEMPDBSTARTUP', N'SNI_HTTP_ACCEPT', N'SP_SERVER_DIAGNOSTICS_SLEEP',
N'SQLTRACE_BUFFER_FLUSH', N'SQLTRACE_INCREMENTAL_FLUSH_SLEEP', N'SQLTRACE_WAIT_ENTRIES',
N'WAIT_FOR_RESULTS', N'WAITFOR', N'WAITFOR_TASKSHUTDOWN', N'WAIT_XTP_HOST_WAIT',
N'WAIT_XTP_OFFLINE_CKPT_NEW_LOG', N'WAIT_XTP_CKPT_CLOSE', N'WAIT_XTP_RECOVERY',
N'XE_BUFFERMGR_ALLPROCESSED_EVENT', N'XE_DISPATCHER_JOIN',
N'XE_DISPATCHER_WAIT', N'XE_LIVE_TARGET_TVF', N'XE_TIMER_EVENT')
AND waiting_tasks_count > 0)
SELECT
MAX (W1.wait_type) AS [WaitType],
CAST (MAX (W1.Percentage) AS DECIMAL (5,2)) AS [Wait Percentage],
CAST ((MAX (W1.WaitS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgWait_Sec],
CAST ((MAX (W1.ResourceS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgRes_Sec],
CAST ((MAX (W1.SignalS) / MAX (W1.WaitCount)) AS DECIMAL (16,4)) AS [AvgSig_Sec],
CAST (MAX (W1.WaitS) AS DECIMAL (16,2)) AS [Wait_Sec],
CAST (MAX (W1.ResourceS) AS DECIMAL (16,2)) AS [Resource_Sec],
CAST (MAX (W1.SignalS) AS DECIMAL (16,2)) AS [Signal_Sec],
MAX (W1.WaitCount) AS [Wait Count],
CAST (N'https://www.sqlskills.com/help/waits/' + W1.wait_type AS XML) AS [Help/Info URL]
FROM Waits AS W1
INNER JOIN Waits AS W2
ON W2.RowNum <= W1.RowNum
GROUP BY W1.RowNum, W1.wait_type
HAVING SUM (W2.Percentage) - MAX (W1.Percentage) < 99 -- percentage threshold
OPTION (RECOMPILE);
------
-- Cumulative wait stats are not as useful on an idle instance that is not under load or performance pressure
-- SQL Server Wait Types Library (Paul Randal)
-- https://bit.ly/2ePzYO2
-- The SQL Server Wait Type Repository
-- https://bit.ly/1afzfjC
-- Wait statistics, or please tell me where it hurts
-- https://bit.ly/2wsQHQE
-- SQL Server 2005 Performance Tuning using the Waits and Queues
-- https://bit.ly/1o2NFoF
-- sys.dm_os_wait_stats (Transact-SQL)
-- https://bit.ly/2Hjq9Yl
-- Get a count of SQL connections by IP address (Query 39) (Connection Counts by IP Address)
SELECT ec.client_net_address, es.[program_name], es.[host_name], es.login_name,
COUNT(ec.session_id) AS [connection count]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
INNER JOIN sys.dm_exec_connections AS ec WITH (NOLOCK)
ON es.session_id = ec.session_id
GROUP BY ec.client_net_address, es.[program_name], es.[host_name], es.login_name
ORDER BY ec.client_net_address, es.[program_name] OPTION (RECOMPILE);
------
-- This helps you figure where your database load is coming from
-- and verifies connectivity from other machines
-- Solving Connectivity errors to SQL Server
-- https://bit.ly/2EgzoD0
-- Get Average Task Counts (run multiple times) (Query 40) (Avg Task Counts)
SELECT AVG(current_tasks_count) AS [Avg Task Count],
AVG(work_queue_count) AS [Avg Work Queue Count],
AVG(runnable_tasks_count) AS [Avg Runnable Task Count],
AVG(pending_disk_io_count) AS [Avg Pending DiskIO Count]
FROM sys.dm_os_schedulers WITH (NOLOCK)
WHERE scheduler_id < 255 OPTION (RECOMPILE);
------
-- Sustained values above 10 suggest further investigation in that area
-- High Avg Task Counts are often caused by blocking/deadlocking or other resource contention
-- Sustained values above 1 suggest further investigation in that area
-- High Avg Runnable Task Counts are a good sign of CPU pressure
-- High Avg Pending DiskIO Counts are a sign of disk pressure
-- How to Do Some Very Basic SQL Server Monitoring
-- https://bit.ly/2q3Btgt
-- Detect blocking (run multiple times) (Query 41) (Detect Blocking)
SELECT t1.resource_type AS [lock type], DB_NAME(resource_database_id) AS [database],
t1.resource_associated_entity_id AS [blk object],t1.request_mode AS [lock req], -- lock requested
t1.request_session_id AS [waiter sid], t2.wait_duration_ms AS [wait time], -- spid of waiter
(SELECT [text] FROM sys.dm_exec_requests AS r WITH (NOLOCK) -- get sql for waiter
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle])
WHERE r.session_id = t1.request_session_id) AS [waiter_batch],
(SELECT SUBSTRING(qt.[text],r.statement_start_offset/2,
(CASE WHEN r.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE r.statement_end_offset END - r.statement_start_offset)/2)
FROM sys.dm_exec_requests AS r WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(r.[sql_handle]) AS qt
WHERE r.session_id = t1.request_session_id) AS [waiter_stmt], -- statement blocked
t2.blocking_session_id AS [blocker sid], -- spid of blocker
(SELECT [text] FROM sys.sysprocesses AS p -- get sql for blocker
CROSS APPLY sys.dm_exec_sql_text(p.[sql_handle])
WHERE p.spid = t2.blocking_session_id) AS [blocker_batch]
FROM sys.dm_tran_locks AS t1 WITH (NOLOCK)
INNER JOIN sys.dm_os_waiting_tasks AS t2 WITH (NOLOCK)
ON t1.lock_owner_address = t2.resource_address OPTION (RECOMPILE);
------
-- Helps troubleshoot blocking and deadlocking issues
-- The results will change from second to second on a busy system
-- You should run this query multiple times when you see signs of blocking
-- Get CPU Utilization History for last 256 minutes (in one minute intervals) (Query 42) (CPU Utilization History)
DECLARE @ts_now bigint = (SELECT cpu_ticks/(cpu_ticks/ms_ticks) FROM sys.dm_os_sys_info WITH (NOLOCK));
SELECT TOP(256) SQLProcessUtilization AS [SQL Server Process CPU Utilization],
SystemIdle AS [System Idle Process],
100 - SystemIdle - SQLProcessUtilization AS [Other Process CPU Utilization],
DATEADD(ms, -1 * (@ts_now - [timestamp]), GETDATE()) AS [Event Time]
FROM (SELECT record.value('(./Record/@id)[1]', 'int') AS record_id,
record.value('(./Record/SchedulerMonitorEvent/SystemHealth/SystemIdle)[1]', 'int')
AS [SystemIdle],
record.value('(./Record/SchedulerMonitorEvent/SystemHealth/ProcessUtilization)[1]', 'int')
AS [SQLProcessUtilization], [timestamp]
FROM (SELECT [timestamp], CONVERT(xml, record) AS [record]
FROM sys.dm_os_ring_buffers WITH (NOLOCK)
WHERE ring_buffer_type = N'RING_BUFFER_SCHEDULER_MONITOR'
AND record LIKE N'%<SystemHealth>%') AS x) AS y
ORDER BY record_id DESC OPTION (RECOMPILE);
------
-- Look at the trend over the entire period
-- Also look at high sustained 'Other Process' CPU Utilization values
-- Note: This query sometimes gives inaccurate results (negative values)
-- on high core count (> 64 cores) systems
-- Get top total worker time queries for entire instance (Query 43) (Top Worker Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_worker_time AS [Total Worker Time], qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a CPU perspective across the entire instance
-- Can also help track down parameter sniffing issues
-- Page Life Expectancy (PLE) value for each NUMA node in current instance (Query 44) (PLE by NUMA Node)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], instance_name, cntr_value AS [Page Life Expectancy]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Buffer Node%' -- Handles named instances
AND counter_name = N'Page life expectancy' OPTION (RECOMPILE);
------
-- PLE is a good measurement of internal memory pressure
-- Higher PLE is better. Watch the trend over time, not the absolute value
-- This will only return one row for non-NUMA systems
-- Page Life Expectancy isn�t what you think�
-- https://bit.ly/2EgynLa
-- Memory Grants Pending value for current instance (Query 45) (Memory Grants Pending)
SELECT @@SERVERNAME AS [Server Name], RTRIM([object_name]) AS [Object Name], cntr_value AS [Memory Grants Pending]
FROM sys.dm_os_performance_counters WITH (NOLOCK)
WHERE [object_name] LIKE N'%Memory Manager%' -- Handles named instances
AND counter_name = N'Memory Grants Pending' OPTION (RECOMPILE);
------
-- Run multiple times, and run periodically if you suspect you are under memory pressure
-- Memory Grants Pending above zero for a sustained period is a very strong indicator of internal memory pressure
-- Memory Clerk Usage for instance (Query 46) (Memory Clerk Usage)
-- Look for high value for CACHESTORE_SQLCP (Ad-hoc query plans)
SELECT TOP(10) mc.[type] AS [Memory Clerk Type],
CAST((SUM(mc.pages_kb)/1024.0) AS DECIMAL (15,2)) AS [Memory Usage (MB)]
FROM sys.dm_os_memory_clerks AS mc WITH (NOLOCK)
GROUP BY mc.[type]
ORDER BY SUM(mc.pages_kb) DESC OPTION (RECOMPILE);
------
-- MEMORYCLERK_SQLBUFFERPOOL was new for SQL Server 2012. It should be your highest consumer of memory
-- CACHESTORE_SQLCP SQL Plans
-- These are cached SQL statements or batches that aren't in stored procedures, functions and triggers
-- Watch out for high values for CACHESTORE_SQLCP
-- Enabling 'optimize for ad hoc workloads' at the instance level can help reduce this
-- Running DBCC FREESYSTEMCACHE ('SQL Plans') periodically may be required to better control this
-- CACHESTORE_OBJCP Object Plans
-- These are compiled plans for stored procedures, functions and triggers
-- Find single-use, ad-hoc and prepared queries that are bloating the plan cache (Query 47) (Ad hoc Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name], t.[text] AS [Query Text],
cp.objtype AS [Object Type], cp.cacheobjtype AS [Cache Object Type],
cp.size_in_bytes/1024 AS [Plan Size in KB]
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
WHERE cp.cacheobjtype = N'Compiled Plan'
AND cp.objtype IN (N'Adhoc', N'Prepared')
AND cp.usecounts = 1
ORDER BY cp.size_in_bytes DESC, DB_NAME(t.[dbid]) OPTION (RECOMPILE);
------
-- Gives you the text, type and size of single-use ad-hoc and prepared queries that waste space in the plan cache
-- Enabling 'optimize for ad hoc workloads' for the instance can help (SQL Server 2008 and above only)
-- Running DBCC FREESYSTEMCACHE ('SQL Plans') periodically may be required to better control this
-- Enabling forced parameterization for the database can help, but test first!
-- Plan cache, adhoc workloads and clearing the single-use plan cache bloat
-- https://bit.ly/2EfYOkl
-- Get top total logical reads queries for entire instance (Query 48) (Top Logical Reads Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_logical_reads AS [Total Logical Reads],
qs.min_logical_reads AS [Min Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.max_logical_reads AS [Max Logical Reads],
qs.min_worker_time AS [Min Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.max_worker_time AS [Max Worker Time],
qs.min_elapsed_time AS [Min Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.max_elapsed_time AS [Max Elapsed Time],
qs.execution_count AS [Execution Count],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive queries from a memory perspective across the entire instance
-- Can also help track down parameter sniffing issues
-- Get top average elapsed time queries for entire instance (Query 49) (Top Avg Elapsed Time Queries)
SELECT TOP(50) DB_NAME(t.[dbid]) AS [Database Name],
REPLACE(REPLACE(LEFT(t.[text], 255), CHAR(10),''), CHAR(13),'') AS [Short Query Text],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.min_elapsed_time, qs.max_elapsed_time, qs.last_elapsed_time,
qs.execution_count AS [Execution Count],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_physical_reads/qs.execution_count AS [Avg Physical Reads],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
ORDER BY qs.total_elapsed_time/qs.execution_count DESC OPTION (RECOMPILE);
------
-- Helps you find the highest average elapsed time queries across the entire instance
-- Can also help track down parameter sniffing issues
-- Look at UDF execution statistics (Query 50) (UDF Stats by DB)
SELECT TOP (25) DB_NAME(database_id) AS [Database Name],
OBJECT_NAME(object_id, database_id) AS [Function Name],
total_worker_time, execution_count, total_elapsed_time,
total_elapsed_time/execution_count AS [avg_elapsed_time],
last_elapsed_time, last_execution_time, cached_time
FROM sys.dm_exec_function_stats WITH (NOLOCK)
ORDER BY total_worker_time DESC OPTION (RECOMPILE);
------
-- sys.dm_exec_function_stats (Transact-SQL)
-- https://bit.ly/2q1Q6BM
-- Showplan Enhancements for UDFs
-- https://bit.ly/2LVqiQ1
-- Database specific queries *****************************************************************
-- **** Please switch to a user database that you are interested in! *****
--USE YourDatabaseName; -- make sure to change to an actual database on your instance, not the master system database
--GO
-- Individual File Sizes and space available for current database (Query 51) (File Sizes and Space)
SELECT f.name AS [File Name] , f.physical_name AS [Physical Name],
CAST((f.size/128.0) AS DECIMAL(15,2)) AS [Total Size in MB],
CAST(f.size/128.0 - CAST(FILEPROPERTY(f.name, 'SpaceUsed') AS int)/128.0 AS DECIMAL(15,2))
AS [Available Space In MB], f.[file_id], fg.name AS [Filegroup Name],
f.is_percent_growth, f.growth, fg.is_default, fg.is_read_only,
fg.is_autogrow_all_files -- New in SQL Server 2016
FROM sys.database_files AS f WITH (NOLOCK)
LEFT OUTER JOIN sys.filegroups AS fg WITH (NOLOCK)
ON f.data_space_id = fg.data_space_id
ORDER BY f.[file_id] OPTION (RECOMPILE);
------
-- Look at how large and how full the files are and where they are located
-- Make sure the transaction log is not full!!
-- is_autogrow_all_files is new for SQL Server 2016. Equivalent to TF 1117 for user databases
-- SQL Server 2016: Changes in default behavior for autogrow and allocations for tempdb and user databases
-- https://bit.ly/2evRZSR
-- Log space usage for current database (Query 52) (Log Space Usage)
SELECT DB_NAME(lsu.database_id) AS [Database Name], db.recovery_model_desc AS [Recovery Model],
CAST(lsu.total_log_size_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Total Log Space (MB)],
CAST(lsu.used_log_space_in_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space (MB)],
CAST(lsu.used_log_space_in_percent AS DECIMAL(10, 2)) AS [Used Log Space %],
CAST(lsu.log_space_in_bytes_since_last_backup/1048576.0 AS DECIMAL(10, 2)) AS [Used Log Space Since Last Backup (MB)],
db.log_reuse_wait_desc
FROM sys.dm_db_log_space_usage AS lsu WITH (NOLOCK)
INNER JOIN sys.databases AS db WITH (NOLOCK)
ON lsu.database_id = db.database_id
OPTION (RECOMPILE);
------
-- Look at log file size and usage, along with the log reuse wait description for the current database
-- Get database scoped configuration values for current database (Query 53) (Database-scoped Configurations)
SELECT configuration_id, name, [value] AS [value_for_primary], value_for_secondary
FROM sys.database_scoped_configurations WITH (NOLOCK) OPTION (RECOMPILE);
------
-- This lets you see the value of these new properties for the current database
-- Clear plan cache for current database
-- ALTER DATABASE SCOPED CONFIGURATION CLEAR PROCEDURE_CACHE;
-- ALTER DATABASE SCOPED CONFIGURATION (Transact-SQL)
-- https://bit.ly/2sOH7nb
-- I/O Statistics by file for the current database (Query 54) (IO Stats By File)
SELECT DB_NAME(DB_ID()) AS [Database Name], df.name AS [Logical Name], vfs.[file_id], df.type_desc,
df.physical_name AS [Physical Name], CAST(vfs.size_on_disk_bytes/1048576.0 AS DECIMAL(10, 2)) AS [Size on Disk (MB)],
vfs.num_of_reads, vfs.num_of_writes, vfs.io_stall_read_ms, vfs.io_stall_write_ms,
CAST(100. * vfs.io_stall_read_ms/(vfs.io_stall_read_ms + vfs.io_stall_write_ms) AS DECIMAL(10,1)) AS [IO Stall Reads Pct],
CAST(100. * vfs.io_stall_write_ms/(vfs.io_stall_write_ms + vfs.io_stall_read_ms) AS DECIMAL(10,1)) AS [IO Stall Writes Pct],
(vfs.num_of_reads + vfs.num_of_writes) AS [Writes + Reads],
CAST(vfs.num_of_bytes_read/1048576.0 AS DECIMAL(10, 2)) AS [MB Read],
CAST(vfs.num_of_bytes_written/1048576.0 AS DECIMAL(10, 2)) AS [MB Written],
CAST(100. * vfs.num_of_reads/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Reads Pct],
CAST(100. * vfs.num_of_writes/(vfs.num_of_reads + vfs.num_of_writes) AS DECIMAL(10,1)) AS [# Write Pct],
CAST(100. * vfs.num_of_bytes_read/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Read Bytes Pct],
CAST(100. * vfs.num_of_bytes_written/(vfs.num_of_bytes_read + vfs.num_of_bytes_written) AS DECIMAL(10,1)) AS [Written Bytes Pct]
FROM sys.dm_io_virtual_file_stats(DB_ID(), NULL) AS vfs
INNER JOIN sys.database_files AS df WITH (NOLOCK)
ON vfs.[file_id]= df.[file_id] OPTION (RECOMPILE);
------
-- This helps you characterize your workload better from an I/O perspective for this database
-- It helps you determine whether you has an OLTP or DW/DSS type of workload
-- Get most frequently executed queries for this database (Query 55) (Query Execution Counts)
SELECT TOP(50) LEFT(t.[text], 50) AS [Short Query Text], qs.execution_count AS [Execution Count],
qs.total_logical_reads AS [Total Logical Reads],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
qs.total_worker_time AS [Total Worker Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_elapsed_time AS [Total Elapsed Time],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
qs.creation_time AS [Creation Time]
--,t.[text] AS [Complete Query Text], qp.query_plan AS [Query Plan] -- uncomment out these columns if not copying results to Excel
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(plan_handle) AS t
CROSS APPLY sys.dm_exec_query_plan(plan_handle) AS qp
WHERE t.dbid = DB_ID()
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Queries 56 through 61 are the "Bad Man List" for stored procedures
-- Top Cached SPs By Execution Count (Query 56) (SP Execution Counts)
SELECT TOP(100) p.name AS [SP Name], qs.execution_count AS [Execution Count],
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time/qs.execution_count AS [Avg Elapsed Time],
qs.total_worker_time/qs.execution_count AS [Avg Worker Time],
qs.total_logical_reads/qs.execution_count AS [Avg Logical Reads],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.execution_count DESC OPTION (RECOMPILE);
------
-- Tells you which cached stored procedures are called the most often
-- This helps you characterize and baseline your workload
-- Top Cached SPs By Avg Elapsed Time (Query 57) (SP Avg Elapsed Time)
SELECT TOP(25) p.name AS [SP Name], qs.min_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
qs.max_elapsed_time, qs.last_elapsed_time, qs.total_elapsed_time, qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime],
qs.total_worker_time AS [TotalWorkerTime],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY avg_elapsed_time DESC OPTION (RECOMPILE);
------
-- This helps you find high average elapsed time cached stored procedures that
-- may be easy to optimize with standard query tuning techniques
-- Top Cached SPs By Total Worker time. Worker time relates to CPU cost (Query 58) (SP Worker Time)
SELECT TOP(25) p.name AS [SP Name], qs.total_worker_time AS [TotalWorkerTime],
qs.total_worker_time/qs.execution_count AS [AvgWorkerTime], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_worker_time DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a CPU perspective
-- You should look at this if you see signs of CPU pressure
-- Top Cached SPs By Total Logical Reads. Logical reads relate to memory pressure (Query 59) (SP Logical Reads)
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_reads AS [TotalLogicalReads],
qs.total_logical_reads/qs.execution_count AS [AvgLogicalReads],qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a memory perspective
-- You should look at this if you see signs of memory pressure
-- Top Cached SPs By Total Physical Reads. Physical reads relate to disk read I/O pressure (Query 60) (SP Physical Reads)
SELECT TOP(25) p.name AS [SP Name],qs.total_physical_reads AS [TotalPhysicalReads],
qs.total_physical_reads/qs.execution_count AS [AvgPhysicalReads], qs.execution_count,
qs.total_logical_reads,qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_physical_reads > 0
ORDER BY qs.total_physical_reads DESC, qs.total_logical_reads DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a read I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Top Cached SPs By Total Logical Writes (Query 61) (SP Logical Writes)
-- Logical writes relate to both memory and disk I/O pressure
SELECT TOP(25) p.name AS [SP Name], qs.total_logical_writes AS [TotalLogicalWrites],
qs.total_logical_writes/qs.execution_count AS [AvgLogicalWrites], qs.execution_count,
ISNULL(qs.execution_count/DATEDIFF(Minute, qs.cached_time, GETDATE()), 0) AS [Calls/Minute],
qs.total_elapsed_time, qs.total_elapsed_time/qs.execution_count AS [avg_elapsed_time],
CASE WHEN CONVERT(nvarchar(max), qp.query_plan) LIKE N'%<MissingIndexes>%' THEN 1 ELSE 0 END AS [Has Missing Index],
FORMAT(qs.last_execution_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Last Execution Time],
FORMAT(qs.cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
-- ,qp.query_plan AS [Query Plan] -- Uncomment if you want the Query Plan
FROM sys.procedures AS p WITH (NOLOCK)
INNER JOIN sys.dm_exec_procedure_stats AS qs WITH (NOLOCK)
ON p.[object_id] = qs.[object_id]
CROSS APPLY sys.dm_exec_query_plan(qs.plan_handle) AS qp
WHERE qs.database_id = DB_ID()
AND qs.total_logical_writes > 0
AND DATEDIFF(Minute, qs.cached_time, GETDATE()) > 0
ORDER BY qs.total_logical_writes DESC OPTION (RECOMPILE);
------
-- This helps you find the most expensive cached stored procedures from a write I/O perspective
-- You should look at this if you see signs of I/O pressure or of memory pressure
-- Lists the top statements by average input/output usage for the current database (Query 62) (Top IO Statements)
SELECT TOP(50) OBJECT_NAME(qt.objectid, dbid) AS [SP Name],
(qs.total_logical_reads + qs.total_logical_writes) /qs.execution_count AS [Avg IO], qs.execution_count AS [Execution Count],
SUBSTRING(qt.[text],qs.statement_start_offset/2,
(CASE
WHEN qs.statement_end_offset = -1
THEN LEN(CONVERT(nvarchar(max), qt.[text])) * 2
ELSE qs.statement_end_offset
END - qs.statement_start_offset)/2) AS [Query Text]
FROM sys.dm_exec_query_stats AS qs WITH (NOLOCK)
CROSS APPLY sys.dm_exec_sql_text(qs.sql_handle) AS qt
WHERE qt.[dbid] = DB_ID()
ORDER BY [Avg IO] DESC OPTION (RECOMPILE);
------
-- Helps you find the most expensive statements for I/O by SP
-- Possible Bad NC Indexes (writes > reads) (Query 63) (Bad NC Indexes)
SELECT OBJECT_NAME(s.[object_id]) AS [Table Name], i.name AS [Index Name], i.index_id,
i.is_disabled, i.is_hypothetical, i.has_filter, i.fill_factor,
s.user_updates AS [Total Writes], s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
s.user_updates - (s.user_seeks + s.user_scans + s.user_lookups) AS [Difference]
FROM sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON s.[object_id] = i.[object_id]
AND i.index_id = s.index_id
WHERE OBJECTPROPERTY(s.[object_id],'IsUserTable') = 1
AND s.database_id = DB_ID()
AND s.user_updates > (s.user_seeks + s.user_scans + s.user_lookups)
AND i.index_id > 1 AND i.[type_desc] = N'NONCLUSTERED'
AND i.is_primary_key = 0 AND i.is_unique_constraint = 0 AND i.is_unique = 0
ORDER BY [Difference] DESC, [Total Writes] DESC, [Total Reads] ASC OPTION (RECOMPILE);
------
-- Look for indexes with high numbers of writes and zero or very low numbers of reads
-- Consider your complete workload, and how long your instance has been running
-- Investigate further before dropping an index!
-- Missing Indexes for current database by Index Advantage (Query 64) (Missing Indexes)
SELECT CONVERT(decimal(18,2), user_seeks * avg_total_user_cost * (avg_user_impact * 0.01)) AS [index_advantage],
migs.last_user_seek, mid.[statement] AS [Database.Schema.Table],
COUNT(1) OVER(PARTITION BY mid.[statement]) AS [missing_indexes_for_table],
COUNT(1) OVER(PARTITION BY mid.[statement], equality_columns) AS [similar_missing_indexes_for_table],
mid.equality_columns, mid.inequality_columns, mid.included_columns,
migs.unique_compiles, migs.user_seeks,
CONVERT(decimal(18,2), migs.avg_total_user_cost) AS [avg_total_user_cost], migs.avg_user_impact,
OBJECT_NAME(mid.[object_id]) AS [Table Name], p.rows AS [Table Rows]
FROM sys.dm_db_missing_index_group_stats AS migs WITH (NOLOCK)
INNER JOIN sys.dm_db_missing_index_groups AS mig WITH (NOLOCK)
ON migs.group_handle = mig.index_group_handle
INNER JOIN sys.dm_db_missing_index_details AS mid WITH (NOLOCK)
ON mig.index_handle = mid.index_handle
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON p.[object_id] = mid.[object_id]
WHERE mid.database_id = DB_ID()
AND p.index_id < 2
ORDER BY index_advantage DESC OPTION (RECOMPILE);
------
-- Look at index advantage, last user seek time, number of user seeks to help determine source and importance
-- SQL Server is overly eager to add included columns, so beware
-- Do not just blindly add indexes that show up from this query!!!
-- Find missing index warnings for cached plans in the current database (Query 65) (Missing Index Warnings)
-- Note: This query could take some time on a busy instance
SELECT TOP(25) OBJECT_NAME(objectid) AS [ObjectName],
cp.objtype, cp.usecounts, cp.size_in_bytes, query_plan
FROM sys.dm_exec_cached_plans AS cp WITH (NOLOCK)
CROSS APPLY sys.dm_exec_query_plan(cp.plan_handle) AS qp
WHERE CAST(query_plan AS NVARCHAR(MAX)) LIKE N'%MissingIndex%'
AND dbid = DB_ID()
ORDER BY cp.usecounts DESC OPTION (RECOMPILE);
------
-- Helps you connect missing indexes to specific stored procedures or queries
-- This can help you decide whether to add them or not
-- Breaks down buffers used by current database by object (table, index) in the buffer cache (Query 66) (Buffer Usage)
-- Note: This query could take some time on a busy instance
SELECT OBJECT_NAME(p.[object_id]) AS [Object Name], p.index_id,
CAST(COUNT(*)/128.0 AS DECIMAL(10, 2)) AS [Buffer size(MB)],
COUNT(*) AS [BufferCount], p.[Rows] AS [Row Count],
p.data_compression_desc AS [Compression Type]
FROM sys.allocation_units AS a WITH (NOLOCK)
INNER JOIN sys.dm_os_buffer_descriptors AS b WITH (NOLOCK)
ON a.allocation_unit_id = b.allocation_unit_id
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON a.container_id = p.hobt_id
WHERE b.database_id = CONVERT(int, DB_ID())
AND p.[object_id] > 100
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'plan_%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'sys%'
AND OBJECT_NAME(p.[object_id]) NOT LIKE N'xml_index_nodes%'
GROUP BY p.[object_id], p.index_id, p.data_compression_desc, p.[Rows]
ORDER BY [BufferCount] DESC OPTION (RECOMPILE);
------
-- Tells you what tables and indexes are using the most memory in the buffer cache
-- It can help identify possible candidates for data compression
-- Get Table names, row counts, and compression status for clustered index or heap (Query 67) (Table Sizes)
SELECT OBJECT_NAME(object_id) AS [ObjectName],
SUM(Rows) AS [RowCount], data_compression_desc AS [CompressionType]
FROM sys.partitions WITH (NOLOCK)
WHERE index_id < 2 --ignore the partitions from the non-clustered index if any
AND OBJECT_NAME(object_id) NOT LIKE N'sys%'
AND OBJECT_NAME(object_id) NOT LIKE N'queue_%'
AND OBJECT_NAME(object_id) NOT LIKE N'filestream_tombstone%'
AND OBJECT_NAME(object_id) NOT LIKE N'fulltext%'
AND OBJECT_NAME(object_id) NOT LIKE N'ifts_comp_fragment%'
AND OBJECT_NAME(object_id) NOT LIKE N'filetable_updates%'
AND OBJECT_NAME(object_id) NOT LIKE N'xml_index_nodes%'
AND OBJECT_NAME(object_id) NOT LIKE N'sqlagent_job%'
AND OBJECT_NAME(object_id) NOT LIKE N'plan_persist%'
GROUP BY object_id, data_compression_desc
ORDER BY SUM(Rows) DESC OPTION (RECOMPILE);
------
-- Gives you an idea of table sizes, and possible data compression opportunities
-- Get some key table properties (Query 68) (Table Properties)
SELECT OBJECT_NAME(t.[object_id]) AS [ObjectName], p.[rows] AS [Table Rows], p.index_id,
p.data_compression_desc AS [Index Data Compression],
t.create_date, t.lock_on_bulk_load, t.is_replicated, t.has_replication_filter,
t.is_tracked_by_cdc, t.lock_escalation_desc, t.is_filetable,
t.is_memory_optimized, t.durability_desc,
t.temporal_type_desc, t.is_remote_data_archive_enabled, t.is_external -- new for SQL Server 2016
FROM sys.tables AS t WITH (NOLOCK)
INNER JOIN sys.partitions AS p WITH (NOLOCK)
ON t.[object_id] = p.[object_id]
WHERE OBJECT_NAME(t.[object_id]) NOT LIKE N'sys%'
ORDER BY OBJECT_NAME(t.[object_id]), p.index_id OPTION (RECOMPILE);
------
-- Gives you some good information about your tables
-- is_memory_optimized and durability_desc were new in SQL Server 2014
-- temporal_type_desc, is_remote_data_archive_enabled, is_external are new in SQL Server 2016
-- sys.tables (Transact-SQL)
-- https://bit.ly/2Gk7998
-- When were Statistics last updated on all indexes? (Query 69) (Statistics Update)
SELECT SCHEMA_NAME(o.Schema_ID) + N'.' + o.[NAME] AS [Object Name], o.[type_desc] AS [Object Type],
i.[name] AS [Index Name], STATS_DATE(i.[object_id], i.index_id) AS [Statistics Date],
s.auto_created, s.no_recompute, s.user_created, s.is_incremental, s.is_temporary,
st.row_count, st.used_page_count
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON o.[object_id] = i.[object_id]
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.stats_id
INNER JOIN sys.dm_db_partition_stats AS st WITH (NOLOCK)
ON o.[object_id] = st.[object_id]
AND i.[index_id] = st.[index_id]
WHERE o.[type] IN ('U', 'V')
AND st.row_count > 0
ORDER BY STATS_DATE(i.[object_id], i.index_id) DESC OPTION (RECOMPILE);
------
-- Helps discover possible problems with out-of-date statistics
-- Also gives you an idea which indexes are the most active
-- sys.stats (Transact-SQL)
-- https://bit.ly/2GyAxrn
-- UPDATEs to Statistics (Erin Stellato)
-- https://bit.ly/2vhrYQy
-- Look at most frequently modified indexes and statistics (Query 70) (Volatile Indexes)
SELECT o.[name] AS [Object Name], o.[object_id], o.[type_desc], s.[name] AS [Statistics Name],
s.stats_id, s.no_recompute, s.auto_created, s.is_incremental, s.is_temporary,
sp.modification_counter, sp.[rows], sp.rows_sampled, sp.last_updated
FROM sys.objects AS o WITH (NOLOCK)
INNER JOIN sys.stats AS s WITH (NOLOCK)
ON s.object_id = o.object_id
CROSS APPLY sys.dm_db_stats_properties(s.object_id, s.stats_id) AS sp
WHERE o.[type_desc] NOT IN (N'SYSTEM_TABLE', N'INTERNAL_TABLE')
AND sp.modification_counter > 0
ORDER BY sp.modification_counter DESC, o.name OPTION (RECOMPILE);
------
-- This helps you understand your workload and make better decisions about
-- things like data compression and adding new indexes to a table
-- Get fragmentation info for all indexes above a certain size in the current database (Query 71) (Index Fragmentation)
-- Note: This query could take some time on a very large database
SELECT DB_NAME(ps.database_id) AS [Database Name], SCHEMA_NAME(o.[schema_id]) AS [Schema Name],
OBJECT_NAME(ps.OBJECT_ID) AS [Object Name], i.[name] AS [Index Name], ps.index_id,
ps.index_type_desc, ps.avg_fragmentation_in_percent,
ps.fragment_count, ps.page_count, i.fill_factor, i.has_filter,
i.filter_definition, i.[allow_page_locks]
FROM sys.dm_db_index_physical_stats(DB_ID(),NULL, NULL, NULL , N'LIMITED') AS ps
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.[object_id] = i.[object_id]
AND ps.index_id = i.index_id
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON i.[object_id] = o.[object_id]
WHERE ps.database_id = DB_ID()
AND ps.page_count > 2500
ORDER BY ps.avg_fragmentation_in_percent DESC OPTION (RECOMPILE);
------
-- Helps determine whether you have framentation in your relational indexes
-- and how effective your index maintenance strategy is
--- Index Read/Write stats (all tables in current DB) ordered by Reads (Query 72) (Overall Index Usage - Reads)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_seeks, s.user_scans, s.user_lookups,
s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
s.user_updates AS [Writes],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_user_scan, s.last_user_lookup, s.last_user_seek
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_seeks + s.user_scans + s.user_lookups DESC OPTION (RECOMPILE); -- Order by reads
------
-- Show which indexes in the current database are most active for Reads
--- Index Read/Write stats (all tables in current DB) ordered by Writes (Query 73) (Overall Index Usage - Writes)
SELECT OBJECT_NAME(i.[object_id]) AS [ObjectName], i.[name] AS [IndexName], i.index_id,
s.user_updates AS [Writes], s.user_seeks + s.user_scans + s.user_lookups AS [Total Reads],
i.[type_desc] AS [Index Type], i.fill_factor AS [Fill Factor], i.has_filter, i.filter_definition,
s.last_system_update, s.last_user_update
FROM sys.indexes AS i WITH (NOLOCK)
LEFT OUTER JOIN sys.dm_db_index_usage_stats AS s WITH (NOLOCK)
ON i.[object_id] = s.[object_id]
AND i.index_id = s.index_id
AND s.database_id = DB_ID()
WHERE OBJECTPROPERTY(i.[object_id],'IsUserTable') = 1
ORDER BY s.user_updates DESC OPTION (RECOMPILE); -- Order by writes
------
-- Show which indexes in the current database are most active for Writes
-- Get in-memory OLTP index usage (Query 74) (XTP Index Usage)
SELECT OBJECT_NAME(i.[object_id]) AS [Object Name], i.index_id, i.[name] AS [Index Name],
i.[type_desc], xis.scans_started, xis.scans_retries,
xis.rows_touched, xis.rows_returned
FROM sys.dm_db_xtp_index_stats AS xis WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON i.[object_id] = xis.[object_id]
AND i.index_id = xis.index_id
ORDER BY OBJECT_NAME(i.[object_id]) OPTION (RECOMPILE);
------
-- This gives you some index usage statistics for in-memory OLTP
-- Returns no data if you are not using in-memory OLTP
-- Guidelines for Using Indexes on Memory-Optimized Tables
-- https://bit.ly/2GCP8lF
-- Look at Columnstore index physical statistics (Query 75) (Columnstore Index Physical Stat)
SELECT OBJECT_NAME(ps.object_id) AS [TableName],
i.[name] AS [IndexName], ps.index_id, ps.partition_number,
ps.delta_store_hobt_id, ps.state_desc, ps.total_rows, ps.size_in_bytes,
ps.trim_reason_desc, ps.generation, ps.transition_to_compressed_state_desc,
ps.has_vertipaq_optimization, ps.deleted_rows,
100 * (ISNULL(ps.deleted_rows, 0))/ps.total_rows AS [Fragmentation]
FROM sys.dm_db_column_store_row_group_physical_stats AS ps WITH (NOLOCK)
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ps.object_id = i.object_id
AND ps.index_id = i.index_id
ORDER BY ps.object_id, ps.partition_number, ps.row_group_id OPTION (RECOMPILE);
------
-- sys.dm_db_column_store_row_group_physical_stats (Transact-SQL)
-- https://bit.ly/2q276XQ
-- Get lock waits for current database (Query 76) (Lock Waits)
SELECT o.name AS [table_name], i.name AS [index_name], ios.index_id, ios.partition_number,
SUM(ios.row_lock_wait_count) AS [total_row_lock_waits],
SUM(ios.row_lock_wait_in_ms) AS [total_row_lock_wait_in_ms],
SUM(ios.page_lock_wait_count) AS [total_page_lock_waits],
SUM(ios.page_lock_wait_in_ms) AS [total_page_lock_wait_in_ms],
SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) AS [total_lock_wait_in_ms]
FROM sys.dm_db_index_operational_stats(DB_ID(), NULL, NULL, NULL) AS ios
INNER JOIN sys.objects AS o WITH (NOLOCK)
ON ios.[object_id] = o.[object_id]
INNER JOIN sys.indexes AS i WITH (NOLOCK)
ON ios.[object_id] = i.[object_id]
AND ios.index_id = i.index_id
WHERE o.[object_id] > 100
GROUP BY o.name, i.name, ios.index_id, ios.partition_number
HAVING SUM(ios.page_lock_wait_in_ms)+ SUM(row_lock_wait_in_ms) > 0
ORDER BY total_lock_wait_in_ms DESC OPTION (RECOMPILE);
------
-- This query is helpful for troubleshooting blocking and deadlocking issues
-- Look at UDF execution statistics (Query 77) (UDF Statistics)
SELECT OBJECT_NAME(object_id) AS [Function Name], execution_count,
total_worker_time, total_logical_reads, total_physical_reads, total_elapsed_time,
total_elapsed_time/execution_count AS [avg_elapsed_time],
FORMAT(cached_time, 'yyyy-MM-dd HH:mm:ss', 'en-US') AS [Plan Cached Time]
FROM sys.dm_exec_function_stats WITH (NOLOCK)
WHERE database_id = DB_ID()
ORDER BY total_worker_time DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Helps you investigate scalar UDF performance issues
-- Does not return information for table valued functions
-- sys.dm_exec_function_stats (Transact-SQL)
-- https://bit.ly/2q1Q6BM
-- Get Query Store Options for this database (Query 78) (QueryStore Options)
SELECT actual_state_desc, desired_state_desc, [interval_length_minutes],
current_storage_size_mb, [max_storage_size_mb],
query_capture_mode_desc, size_based_cleanup_mode_desc
FROM sys.database_query_store_options WITH (NOLOCK) OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that Query Store is enabled for this database
-- Tuning Workload Performance with Query Store
-- https://bit.ly/1kHSl7w
-- Get highest aggregate duration queries over last hour (Query 79) (High Aggregate Duration Queries)
WITH AggregatedDurationLastHour
AS
(SELECT q.query_id, SUM(count_executions * avg_duration) AS total_duration,
COUNT (distinct p.plan_id) AS number_of_plans
FROM sys.query_store_query_text AS qt WITH (NOLOCK)
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON qt.query_text_id = q.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
INNER JOIN sys.query_store_runtime_stats AS rs WITH (NOLOCK)
ON rs.plan_id = p.plan_id
INNER JOIN sys.query_store_runtime_stats_interval AS rsi WITH (NOLOCK)
ON rsi.runtime_stats_interval_id = rs.runtime_stats_interval_id
WHERE rsi.start_time >= DATEADD(hour, -1, GETUTCDATE())
AND rs.execution_type_desc = N'Regular'
GROUP BY q.query_id),
OrderedDuration AS
(SELECT query_id, total_duration, number_of_plans,
ROW_NUMBER () OVER (ORDER BY total_duration DESC, query_id) AS RN
FROM AggregatedDurationLastHour)
SELECT OBJECT_NAME(q.object_id) AS [Containing Object], qt.query_sql_text,
od.total_duration AS [Total Duration (microsecs)],
od.number_of_plans AS [Plan Count],
p.is_forced_plan, p.is_parallel_plan, p.is_trivial_plan,
q.query_parameterization_type_desc, p.[compatibility_level],
p.last_compile_start_time, q.last_execution_time,
CONVERT(xml, p.query_plan) AS query_plan_xml
FROM OrderedDuration AS od
INNER JOIN sys.query_store_query AS q WITH (NOLOCK)
ON q.query_id = od.query_id
INNER JOIN sys.query_store_query_text AS qt WITH (NOLOCK)
ON q.query_text_id = qt.query_text_id
INNER JOIN sys.query_store_plan AS p WITH (NOLOCK)
ON q.query_id = p.query_id
WHERE od.RN <= 50
ORDER BY total_duration DESC OPTION (RECOMPILE);
------
-- New for SQL Server 2016
-- Requires that QueryStore is enabled for this database
-- Get input buffer information for the current database (Query 80) (Input Buffer)
SELECT es.session_id, DB_NAME(es.database_id) AS [Database Name],
es.login_time, es.cpu_time, es.logical_reads,
es.[status], ib.event_info AS [Input Buffer]
FROM sys.dm_exec_sessions AS es WITH (NOLOCK)
CROSS APPLY sys.dm_exec_input_buffer(es.session_id, NULL) AS ib
WHERE es.database_id = DB_ID()
AND es.session_id > 50
AND es.session_id <> @@SPID OPTION (RECOMPILE);
-- Gives you input buffer information from all non-system sessions for the current database
-- Replaces DBCC INPUTBUFFER
-- New DMF for retrieving input buffer in SQL Server
-- https://bit.ly/2uHKMbz
-- Look at recent Full backups for the current database (Query 81) (Recent Full Backups)
SELECT TOP (30) bs.machine_name, bs.server_name, bs.database_name AS [Database Name], bs.recovery_model,
CONVERT (BIGINT, bs.backup_size / 1048576 ) AS [Uncompressed Backup Size (MB)],
CONVERT (BIGINT, bs.compressed_backup_size / 1048576 ) AS [Compressed Backup Size (MB)],
CONVERT (NUMERIC (20,2), (CONVERT (FLOAT, bs.backup_size) /
CONVERT (FLOAT, bs.compressed_backup_size))) AS [Compression Ratio], bs.has_backup_checksums, bs.is_copy_only, bs.encryptor_type,
DATEDIFF (SECOND, bs.backup_start_date, bs.backup_finish_date) AS [Backup Elapsed Time (sec)],
bs.backup_finish_date AS [Backup Finish Date], bmf.physical_device_name AS [Backup Location], bmf.physical_block_size
FROM msdb.dbo.backupset AS bs WITH (NOLOCK)
INNER JOIN msdb.dbo.backupmediafamily AS bmf WITH (NOLOCK)
ON bs.media_set_id = bmf.media_set_id
WHERE bs.database_name = DB_NAME(DB_ID())
AND bs.[type] = 'D' -- Change to L if you want Log backups
ORDER BY bs.backup_finish_date DESC OPTION (RECOMPILE);
------
-- Are your backup sizes and times changing over time?
-- Are you using backup compression?
-- Are you using backup checksums?
-- Are you doing copy_only backups?
-- Are you doing encrypted backups?
-- Have you done any backup tuning with striped backups, or changing the parameters of the backup command?
-- In SQL Server 2016, native SQL Server backup compression actually works much better with databases that are using TDE than in previous versions
-- https://bit.ly/28Rpb2x
-- These four Pluralsight Courses go into more detail about how to run these queries and interpret the results
-- SQL Server 2017: Diagnosing Configuration Issues with DMVs
-- https://bit.ly/2MSUDUL
-- SQL Server 2014 DMV Diagnostic Queries � Part 1
-- https://bit.ly/2plxCer
-- SQL Server 2014 DMV Diagnostic Queries � Part 2
-- https://bit.ly/2IuJpzI
-- SQL Server 2014 DMV Diagnostic Queries � Part 3
-- https://bit.ly/2FIlCPb
-- Sign up for Microsoft Visual Studio Dev Essentials and get a free three month pass to Pluralsight
-- Microsoft Visual Studio Dev Essentials
-- http://bit.ly/1q6xbDL
-- Sign up for Microsoft Azure Essentials and get lots of free Azure usage credits, MCP exam voucher, three month Pluralsight subscription
-- Microsoft Azure Essentials
-- https://bit.ly/2JMWe8x
-- August 2017 blog series about upgrading and migrating to SQL Server 2016/2017
-- https://bit.ly/2ftKVrX
md5: 336D96B873E2C70F6C81370F19521E09 | sha1: 3E9DEA38211CB0FA680127CAABD358F9DA54F270 | sha256: DFD6BE0724F0ECF76A1DA670B40A5D155C3B9043E598411B79813FF4B21984E4 | sha512: A02E4B667BCFAEB68D12515D38FA5F7CBBBE6983EEC989947941FA5FD63A717CC5F6A38E8B8FB24058D3D348959B0BA1A3D043EB211BB70CDA47B1684174CCE7
md5: 7446B5C8FFCBA09039ABF785D1BB4A88 | sha1: 6AD988335E008315F06A43A722DF69AB5B4722F0 | sha256: 3407221FE6F297E845AEB91A4886BB7B268A79CA2A73E273BDC2D36ECA26ADA6 | sha512: 752433FCFAE9F16292B07F18A9416A7FE786F82038BB7E0C30E79FD1B2ED68BC9DB60143B68F29B05CE412DB8ACE34E3A7609CDBE0FF14B0AB28AEEE98A43CB9
md5: 9208D9667BAE268B63C09BF8E6C79FE4 | sha1: A3DA904733DE2F8161A1103F8061C4392D97BA6C | sha256: F0A1A6600895B521AFE9C17F545D851DB218BCCE93C76A3E96608115F4F4DEBC | sha512: DADDBD541CF0DE43E9D0BEDA524453EBEE533BDC30957E8F71C3D1F5CC76D0D3339061FB06C2FA9F9F92258E5E31FF13E6179F77FA30B1B984E1419E1FE589A7
md5: EDCC8CFC99AAD924ADCA73096FEB892C | sha1: 92CD8EE21D8A07127BB0F379BFDBC48D54A998DF | sha256: 0D60EDB8ECAD19D45862A2738F7A688011DE28F2F2A5F92CC663898D4D091B17 | sha512: AE6080A45B9B16C07DA2FAD5E5DA719842A3D80EA910B59912251C511300DF26EB64FFD27D53D54A80040DB763980D5485E084A0B76797A88F3B9D72BA70E4A1
md5: 11CE124B92362C6DAF66E038515A2DF5 | sha1: E11F403F9A92ED69CB5D3ECFF464B9286D50587C | sha256: DF15554804BB08351DF170434E2E994475F6AA3F5B6A465CA30052A13F6EAF0A | sha512: 5036C4855CE72374BC688010D4A0E5F0A9F55F08B5B4D5421C8A53EB4CB7DB53AC42493AA79D7774682427FAFDC38A47D083E16D5973E49BC821EFB88BFDD424
md5: 2DD7BA70365204298B4A381D500F433C | sha1: AF2655A5220761227E33EF89583346C7FFD9CD72 | sha256: 2A7D545774CAD03C72F3E6E5B06B65F75A716052B0A2D36E48DA3124BF0B54FD | sha512: 490F1D96C33FAEA13F73109D6068C887D86B86E7BDEA002DCBA42AB2DE3C47E8E63ED1C345AF252163D72FC6FE7045635A1C64BA8B3ACB3A9C50E7FF63584817
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.SqlServer.Dac.Extensions</name>
</assembly>
<members>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisModelValidationMode">
<summary>
Determines the validation performed on the model prior to code analysis.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisModelValidationMode.Full">
<summary>
The TSqlModel is fully validated prior to code analysis.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisModelValidationMode.None">
<summary>
No validation is performed on the TSqlModel prior to code analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult">
<summary>
The results of Code Analysis against a particular model. Will include any
<see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>s found, in addition to any errors that occurred
during analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.#ctor">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.GetAllErrors">
<summary>
Gets all errors, whether during initialization or during the analysis process. This
does not include the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.Problems"/> found during analysis since these are
returned separately.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.SerializeResultsToXml(System.String)">
<summary>
Serializes the results in XML format to an output file.
Only the problems discovered during analysis are output. No errors that occurred during
the analysis process will be output.
</summary>
<param name="outputFilename">
The filename for the output file.
This should be a fully qualified path to the file, or if a relative file path is used
then the resolved path will be relative to the location of the executable running for
your process.
If a relative file path is used this w
</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.SerializeResultsToXml(System.IO.Stream)">
<summary>
Serializes the results in XML format to an output stream. For backwards compatibility
Only the problems discovered during analysis are output. No errors that occurred during
the analysis process will be output.
</summary>
<param name="output">
An output stream to write the XML results to. This must support write
</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.Problems">
<summary>
Any problems discovered by the rules run during code analysis
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.AnalysisErrors">
<summary>
Errors and messages that occurred during analysis.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.InitializationErrors">
<summary>
Gets errors that occurred during initialization of code analysis, rule lookup,
and anything other than the analysis itself.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.SuppressionErrors">
<summary>
Gets errors that occurred during calling of the message suppression routine.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.AnalysisSucceeded">
<summary>
Was analysis completed successfully? Analysis may fail for a number of reasons, for instance
if errors already exist in the model before processing.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService">
<summary>
A service that runs code analysis against a model and provides results to the caller.
Note that this class is not thread-safe since multiple simulataneous calls to <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Analyze(Microsoft.SqlServer.Dac.Model.TSqlModel)"/> are
not supported. However it is possible to call <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Cancel"/> from a thread while a separate thread is
waiting on the <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Analyze(Microsoft.SqlServer.Dac.Model.TSqlModel)"/> method to complete.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.GetRules">
<summary>
Gets the rules loaded by the service. The current state of these rules (enabled, disabled, rule problem severity)
can be queried, as can information about the rule such as its ID and metadata.
</summary>
<returns>
list of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor"/> objects representing rules discovered by the service, their metadata and status
</returns>
<remarks>To discover any problems loading rules, <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.GetRuleLoadErrors"/> should be called</remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.GetRuleLoadErrors">
<summary>
Gets any errors that may have occurred during loading of the analysis rules.
This causes rules to be loaded by the service.
</summary>
<returns>A list of errors that occurred during rule loading.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ApplyRuleSettings(Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings)">
<summary>
Applies the specified rule settings against the service's configuration.
</summary>
<param name="settings"><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> describing which rules should be run</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.SetProblemSuppressor(System.Predicate{Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext})">
<summary>
Sets the problem suppression predicate to be applied when suppressing rules.
This is an optional feature that supports ignoring problems raised by a rule.
The problem might be suppressed based on the element the problem was raised against, or the source
that the problem was found in.
</summary>
<param name="shouldSuppressProblem">
Predicate that should examine the suppression context and decide whether the problem needs to be suppressed
</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Cancel">
<summary>
Cancels execution of the analysis service
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Analyze(Microsoft.SqlServer.Dac.Model.TSqlModel)">
<summary>
Performs the analysis of the model. This will initialize all required resources, run analysis
and report back results to the caller.
If the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ResultsFile"/> and/or <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.CodeAnalysisSucceededFile"/>
are specified then these will be deleted at the start of the analysis, and new files created at the
end of the analysis
</summary>
<param name="model">The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> to be analyzed</param>
<returns>
<see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult"/> describing the problems found and any errors that
occurred during processing
</returns>
<exception cref="T:System.ArgumentNullException">If the <paramref name="model"/> is null</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.Execute">
<summary>
Main entry point for task execution.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ExecuteValidateElementStatusStep">
<summary>
Ensure the model builds successfully - otherwise there is no point in continuing analysis
since for SCA it's assumed that the model is valid already.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ExecuteInitializeMessageSuppressionStep">
<summary>
Wrap whatever message suppression logic has been defined in a routine that will
call into that code and catch any errors thrown by customer logic
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.SuppressProblemCallback(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext)">
<summary>
Check if the rule in context is suppressed. Handles exceptions thrown by the problem suppression code
so that execution does not get stopped due to issues in external code
</summary>
<param name="context"></param>
<returns>Return true if rule is suppressed for modelElement; false otherwise</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ResultsFile">
<summary>
Optional path to a results file. If this is specified, the analysis service will save all results to
an XML file at the end of analysis. If no file path is specified then this will not be done automatically,
but <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.SerializeResultsToXml(System.String)"/> can be used to output the results after
analysis has completed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.CodeAnalysisSucceededFile">
<summary>
Optional path to a file that is created if analysis succeeds. This can be used to check whether analysis
should be run or not - for instance if analyzing a dacpac, comparing the modification time for the dacpac versus
the analysis success file can tell you whether the dacpac is more recent than the last analysis.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ValidationMode">
<summary>
Determines the validation performed on the model prior to code analysis. This can be used to bypass
the requirement that a TSqlModel be valid prior to analysis by a code analysis rule.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.CancellationToken">
<summary>
The <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.CancellationToken"/> used to indicate whether execution should be canceled.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.IsCanceled">
<summary>
Gets a value that indicates whether the analysis was canceled
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory">
<summary>
Factory class that supports creation of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> objects.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.TSqlModel)">
<summary>
Creates an analysis service with the standard properties and all rules turned on by default.
This is a convenience method that takes the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.Version"/> from the model
and passes it to the <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.SqlServerVersion)"/>
method.
</summary>
<param name="model">
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> that will be analyzed. The version of the model must be known at the
time the service is created since only rules compatible with that <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>
will be loaded and run.
</param>
<returns>
A <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> that can analyze the contents of the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>
</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings)">
<summary>
Creates an analysis service and configures it using the <paramref name="settings"/> passed to the method.
The settings are a convenient way to set up the service in one step, but if you wish to
specify some settings after creating the service this is possible via methods and properties on
the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> itself.
This is a convenience method that takes the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.Version"/> from the model
and passes it to the <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.SqlServerVersion)"/>
method.
</summary>
<param name="model">
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> that will be analyzed. This must be known at the time the
service is created since only rules compatible with the <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> for the model
will be loaded and run.
</param>
<param name="settings">Settings object defining how to configure the service</param>
<returns>A <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> that can analyze the contents of the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.SqlServerVersion)">
<summary>
Creates an analysis service with the standard properties and all rules turned on by default.
</summary>
<param name="version">
The expected <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> of models to be analyzed. This should be known at the time the
service is created since only rules compatible with this <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>
will be loaded and run.
</param>
<returns>
A <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> that can analyze the contents of the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>
</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceFactory.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.SqlServerVersion,Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings)">
<summary>
Creates an analysis service and configures it using the <paramref name="settings"/> passed to the method.
The settings are a convenient way to set up the service in one step, but if you wish to
specify some settings after creating the service this is possible via methods and properties on
the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> itself.
</summary>
<param name="version">
The expected <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> of models to be analyzed. This must be known at the time the
service is created since only rules compatible with this <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>
will be loaded and run.
</param>
<param name="settings">Settings object defining how to configure the service</param>
<returns>A <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> that can analyze the contents of the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/></returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings">
<summary>
Defines the optional configuration settings for a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/>. This can determine which
rules are run, how to suppress certain problems, and where to save results to.
These settings can also be set on the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> after it has been created, but are included
here to make construction more convenient.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings"/> object.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.RuleSettings">
<summary>
Optional rule settings define what rules should be run during analysis and the severity of the problems created.
If no <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> are specified the default behavior is to run all discovered rules.
This property is applied using <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ApplyRuleSettings(Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings)"/>.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.ShouldSuppressProblem">
<summary>
An optional predicate that can be used to suppress problems raised by rules during analysis.
See <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.SetProblemSuppressor(System.Predicate{Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext})"/> for more information.
This property is applied using <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.SetProblemSuppressor(System.Predicate{Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext})"/>.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.ResultsFile">
<summary>
Optional path to a results file. If this is specified, the analysis service will save all results to
an XML file at the end of analysis. If no file path is specified then this will not be done automatically,
but <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisResult.SerializeResultsToXml(System.String)"/> can be used to output the results after
analysis has completed.
This property directly maps to <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.ResultsFile"/>.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.CodeAnalysisSucceededFile">
<summary>
Optional path to a file that is created if analysis succeeds. This can be used to check whether analysis
should be run or not - for instance if analyzing a dacpac, comparing the modification time for the dacpac versus
the analysis success file can tell you whether the dacpac is more recent than the last analysis.
This property directly maps to <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService.CodeAnalysisSucceededFile"/>.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.ValidationMode">
<summary>
Determines the validation performed on the model prior to code analysis. This can be used to bypass
the requirement that a TSqlModel be valid prior to analysis by a code analysis rule.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils">
<summary>
Internal rule utilities that will never meet the conditions for sharing with the public via an open API
or inclusion in a sample project
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils.TryGetTSqlObject(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.Data.Tools.Schema.Sql.SchemaModel.ISqlModelElement,Microsoft.SqlServer.Dac.Model.TSqlObject@)">
<summary>
Tries to map an internal element to a public element.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils.GetSchemaObjectName(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Get the schema object name in EscapedFullyQualifiedName format from an ISqlModelElement
</summary>
<param name="model"></param>
<param name="element"></param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils.GetSchemaObjectName(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
Get the schema object name in EscapedFullyQualifiedName format from a Sql element Descriptor
</summary>
<param name="model"></param>
<param name="elementDescriptor"></param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils.GetSchemaObjectName(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.ElementDescriptor,Microsoft.SqlServer.Dac.Model.ElementNameStyle)">
<summary>
Get the schema object name in user's choice of format from a Sql element Descriptor
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.RuleUtils.GetSchemaObjectName(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.Model.ElementNameStyle)">
<summary>
Get the schema object name in user's choice of format from an ISqlModelElement
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException">
<summary>
Represents an exception that occurred when running the rule problem suppression test.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacModelException">
<summary>
Exception throw from DAC model errors.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DacModelException.#ctor">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Model.DacModelException"/> class.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DacModelException.#ctor(System.String)">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Model.DacModelException"/> class with the specified error message.
</summary>
<param name="message"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DacModelException.#ctor(System.String,System.Exception)">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Model.DacModelException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">
The message that describes the error.
</param>
<param name="innerException">
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DacModelException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
</summary>
<param name="info"></param>
<param name="context"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DacModelException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Write exception information to the supplied <see cref="T:System.Runtime.Serialization.SerializationInfo"/> object.
</summary>
<param name="info">
<see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.
</param>
<param name="context">
<see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.
</param>
<exception cref="T:System.ArgumentNullException">
If <paramref name="info"/> is a null reference.
</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelException.Messages">
<summary>
Get collection of additional error, warning, and informational messages associated with this exception.
</summary>
<value>
Collection of additional messages associated with this exception.
</value>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException.#ctor">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException"/> class.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException.#ctor(System.String)">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException"/> class with the specified error message.
</summary>
<param name="message"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException.#ctor(System.String,System.Exception)">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException"/> class with the specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">
The message that describes the error.
</param>
<param name="innerException">
The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor">
<summary>
Represents the problem suppressor used by SSDT projects. The <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.ShouldSuppressProblem"/> method
can be passed to <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisServiceSettings.ShouldSuppressProblem"/> in order to use this
class.
This reads suppression information from a file with a name matching
<see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.SuppressionFilename"/> ("StaticCodeAnalysis.SuppressMessages.xml") in the root directory.
All relative paths will be resolved relative to the project folder defined in the constructor
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.SuppressionFilename">
<summary>
The default file name for a message suppression file within a project.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.CreateSuppressor(Microsoft.Data.Tools.Schema.Sql.RuleEngine.MessageSuppressionFileManager)">
<summary>
Internal factory method that creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/>.
</summary>
<param name="suppressionFileManager">
The file manager to use for loading/saving suppression rules.
</param>
<returns><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/></returns>
<exception cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException">
Thrown if there was a problem parsing the XML
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.CreateSuppressor(System.String)">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/>.
</summary>
<param name="projectFolder">
The folder in which the XML Message suppression file is found.
Any rule suppressed using a relative file path will base the full path off
this folder location.
</param>
<returns><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/> </returns>
<exception cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException">
Thrown if the Path to the XML file was invalid or if there was a problem parsing the XML
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.CreateSuppressor(System.String,System.String)">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/>.
</summary>
<param name="projectFolder">
The folder in which the XML Message suppression file is found.
Any rule suppressed using a relative file path will base the full path off
this folder location.
</param>
<param name="suppressionFilename">'
The name of the XML message suppression file. This is expected to be under the project folder.
</param>
<returns><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor"/> </returns>
<exception cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ProblemSuppressionException">
Thrown if the Path to the XML file was invalid or if there was a problem parsing the XML
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.ResetSuppressedProblems">
<summary>
Resets the suppressed problems to their default state. If an XML suppression file for the
project existed already then the state will be reloaded from there, otherwise it will
be reset so that no problems are suppressed.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.UnsuppressRulesFromFile(System.String)">
<summary>
Removes all problem suppression directives for a particular filename.
The updated set of problems to suppress will be immediately written out to the backing XML file that describes what
rules should be suppressed for a given file.
</summary>
<param name="fileName">path to the file</param>
<exception cref="T:System.ArgumentNullException">If the <paramref name="fileName"/> is null</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.GetSuppressedProblems">
<summary>
Gets information on what problems will be suppressed. Specifically, a set of
<see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo"/> objects will be returned that defines each combination of a
rule being suppressed and the file name for which the rule is suppressed.
</summary>
<returns>A list of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo"/> objects defining each combination of a
rule being suppressed and the file name for which the rule is suppressed</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.AddSuppressedProblems(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo})">
<summary>
Adds one or more instances of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo"/> to the set of suppressed problems.
The full set of suppressed problems will be immediately written out to the backing XML file.
</summary>
<param name="suppressedProblems">
An IEnumerable of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo"/> objects defining each combination of a
file for which some problems should be suppressed, and the specific rule whose problems should be
suppressed.
</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ProjectProblemSuppressor.ShouldSuppressProblem">
<summary>
Gets the predicate that can be used to
If any errors occur during
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor">
<summary>
Describes a rule discovered by the rule engine and supports configuration of its properties.
Descriptors inherit properties from <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/>, to support enabling/disabling the rule during
analysis and specifying the severity for problems created by the rule.
This class is not intended to be subclasses by external users - instances of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor"/> are created
by the analysis service.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration">
<summary>
Specifies how a rule should be configured - should this be enabled or disabled? What severity should be applied
for the rule?
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.#ctor(System.String)">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> for a rule, using the default settings for <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.Enabled"/>
and <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.Severity"/>.
</summary>
<param name="ruleId">ID of the rule this configuration specifies. Cannot be null or whitespace.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.#ctor(System.String,System.Boolean,Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity)">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> for a rule.
</summary>
<param name="ruleId">ID of the rule this configuration specifies. Cannot be null or whitespace.</param>
<param name="enabled">Is this rule enabled or disabled?</param>
<param name="severity">What is the severity of problems identified by this rule? Should be either
<see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Warning"/> or <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Error"/>.</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.RuleId">
<summary>
Gets the unique Id used to identify the rule. This is the fully qualified ID, which would usually be
in the form "My.Org.MyRuleName".
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.Namespace">
<summary>
Gets the namespace for the rule. This is the part of the rule that precedes the final "." in the ID name.
For instance for a rule ID "My.Org.MyRuleName", the namespace would be "My.Org".
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.ShortRuleId">
<summary>
Gets the last part of the rule ID. This is the part of the rule that follows the final "." in the ID name.
For instance for a rule ID "My.Org.MyRuleName", the short rule ID would be "MyRuleName".
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.Enabled">
<summary>
Specifies if the rule is enabled and should be included in the code analysis.
The default value is true
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration.Severity">
<summary>
What severity should problems created by the rule have?
The default severity is <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Warning"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.#ctor(System.String)">
<summary>
Protected constructor to be called by implementing classes.
</summary>
<param name="ruleId">ID of the rule being described</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.DisplayDescription">
<summary>
The description of the rule. This should be a short human readable description of what the
rule is intended to warn against or block.
This is automatically read from the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.Metadata"/> property
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.DisplayName">
<summary>
Display name describing the rule.
This is automatically read from the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.Metadata"/> property
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.Rule">
<summary>
The actual instance of the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlAnalysisRule"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor.Metadata">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata"/> describing the rule.
This is a required property that must be defined by subclasses.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings">
<summary>
The settings used to configure rules used during analysis.
Before analysis begins, this settings object will be applied to the rules discovered
by the analysis service. If DisableRulesNotInSettings is set to true then any rules
not included in these settings will be disabled and not run during analysis.
These settings are applied by calling the <see cref="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.ApplySettingsToRules(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration})"/> method
on rules returned by the engine.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.#ctor">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> object.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.#ctor(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration})">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> containing a set of rules.
</summary>
<param name="rules">The rules to include</param>
<exception cref="T:System.ArgumentNullException">If <paramref name="rules"/> is null</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.CreateFromSettingsString(System.String,System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> configuration based on a settings string like the one used
inside SSDT project files. This string defines what rules should be disabled or have their problems treated as
errors instead of warnings. Any rule not included in the settings string will be enabled by default.
</summary>
<param name="settingsString">
A semicolon delimited string identifying rules to be disabled or have problems treated as errors.
The format is "-My.Disabled.Rule;+!My.Enabled.RuleWithError;-!My.Disabled.RuleWithError". Hence disabled rules should have "-"
before their ID and enabled rules with errors should have "+!" before their ID.
Only rules that are to be disabled or have their problems treated as errors should be included in the settings string.
If this parameter is null or contains no valid rules, a default empty configuration will be returned. This will result in all
discovered rules being run.
</param>
<param name="errors">List of errors found when processing the list.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.ConvertToSettingsString">
<summary>
Converts the rule configuration info in this <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings"/> object into a
settings string like the one used
inside SSDT project files. This string defines what rules should be disabled or have their problems treated as
errors instead of warnings. Any rule not included in the settings string will be enabled by default.
</summary>
<returns>
A semicolon delimited string identifying rules to be disabled or have problems treated as errors.
The format is "-My.Disabled.Rule;+!My.Enabled.RuleWithError;-!My.Disabled.RuleWithError". Hence disabled rules have "-"
before their ID and enabled rules with errors have "+!" before their ID.
Only rules that are to be disabled or have their problems treated as errors should be included in the settings string.
</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.AddRange(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration})">
<summary>
Adds multiple <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> objects to the list of rules
</summary>
<param name="rules">The rules to include</param>
<exception cref="T:System.ArgumentNullException">If <paramref name="rules"/> is null</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.Add(Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration)">
<summary>
Adds a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> object to the list of rules
</summary>
<param name="item">item to be added</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.Remove(Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration)">
<summary>
Removes a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> object from the list of rules.
</summary>
<param name="item">item to be removed</param>
<returns>true if the item was successfully removed</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.GetEnumerator">
<summary>
<see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.FindConfiguration(System.String)">
<summary>
Tries to find the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> that matches the specified
<paramref name="ruleId"/>. If the configuration doesn't exist then null will be returned
</summary>
<param name="ruleId">The fully qualified rule ID</param>
<returns><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/>, or null if none matches the <paramref name="ruleId"/></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.TryGetRuleConfiguration(System.String,Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration@)">
<summary>
Tries to find the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> that matches the specified
<paramref name="ruleId"/>.
</summary>
<param name="ruleId">The fully qualified rule ID</param>
<param name="config">out <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/>, or null if none matches the <paramref name="ruleId"/></param>
<returns>true if a configuration matching the specified <paramref name="ruleId"/> was found, false otherwise</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.ApplySettingsToRules(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration})">
<summary>
Applies these settings to another set of rules.
</summary>
<param name="rules">The rules the settings should be applied to</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.EnableRule(System.String)">
<summary>
Includes a rule for execution
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.DisableRule(System.String)">
<summary>
Excludes a rule from execution
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.TreatRuleProblemAsWarning(System.String)">
<summary>
Treat any problems found a rule as warnings
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.TreatRuleProblemAsError(System.String)">
<summary>
Treat any problems found a rule as errors
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.IsRuleDisabled(System.String)">
<summary>
Is a particular rule in the rule settings disabled?
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<returns>true if the problem is disabled; false otherwise</returns>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.IsRuleProblemTreatedAsError(System.String)">
<summary>
Is a particular rule in the rule settings treated as error?
</summary>
<param name="ruleId">Fully qualified Id for the rule</param>
<returns>true if the problem is treated as error; false otherwise</returns>
<exception cref="T:System.ArgumentException">If the <paramref name="ruleId"/> is null or whitespace</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisRuleSettings.DisableRulesNotInSettings">
<summary>
Should rules not found in these settings be disabled? The default is "false", so that
any rules not explicitly covered in the settings will still be run during analysis.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException">
<summary>
Represent an exception that may occur during a code analysis run
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException.#ctor">
<summary>
Initialize a new instance of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException"/>
Exception message and inner exceptions are set to null
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException.#ctor(System.String)">
<summary>
Initialize a new instance of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException"/> with a message
</summary>
<param name="message">Exception message</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException.#ctor(System.String,System.Exception)">
<summary>
Initialize a new instance of <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleException"/> with a message and an inner exception
</summary>
<param name="message">Exception message</param>
<param name="innerException">Inner exception to attached to this exception</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.CommonUtilities.ElementNameAstLocatorSchemaAnalyzer">
<summary>
The class to locate the accurate AST that defines the name for a model element
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer">
<summary>
The base class that defines analysis events.
This analyzer works against the <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/>s that represent
the exact DDL language describing an object.
This makes it easier to examine the actual script/fragment structure that represents
an object.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)">
<summary>
This method handles pre-batchprocessing
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)">
<summary>
This method handles post-batchprocessing
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
This method handles pre-DDL statement processing
</summary>
<param name="fragment">Node that will be processed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
This method handles post-DDL statement processing
</summary>
<param name="fragment">Node that was processed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.IdentifiedElement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
This method handles the discovery of a new Symbol
</summary>
<param name="fragment">Fragment the symbol belongs to</param>
<param name="elementDescriptor">The element descriptor</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
This method handles the pre-DML statement processing
</summary>
<param name="fragment">Node that will be processed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
This method handles the post-DML statement processing
</summary>
<param name="fragment">Node that will be processed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.VisitFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor,Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance)">
<summary>
This method handles additional processing required for a node/schemaidentifier
</summary>
<param name="fragment">Node to be processed</param>
<param name="elementDescriptor">Descriptor to be processed</param>
<param name="relevance">Relevance</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.VisitAmbiguousFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor})">
<summary>
This method handles additional processing required for a node/schemaidentifier
</summary>
<param name="fragment">Node to be processed</param>
<param name="possibilities">An enumerable of possible hits</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.IdentifiedSupportingStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
This method handles the discovery of a new supporting statement
</summary>
<param name="fragment">Node to be processed</param>
<param name="elementDescriptor"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.AnalyzeScript(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
Runs the schema analysis against a fragment
</summary>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> the fragment is linked to</param>
<param name="sqlFragment">the fragment to analyze</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.CommonUtilities.ElementNameAstLocatorSchemaAnalyzer.NameAstNode">
<summary>
The TSqlFragment referring to the name of the element
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.CommonUtilities.ElementNameAstLocatorSchemaAnalyzer.ElementAstNode">
<summary>
The TSqlFragment referring to the element itself
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlCodeAnalysisRule">
<summary>
Base class for SQL static code analysis rules. An analysis rule analyzes a model / model element and returns a list of
problems found during analysis.
Implementing classes must have a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute"/> defined on the
class definition to be discovered and used during code analysis.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlAnalysisRule">
<summary>
Base class for all types of analysis rule. An analysis rule analyzes a model / model element and returns a list of
problems found during analysis.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SqlAnalysisRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
Performs analysis and returns a list of problems detected
</summary>
<param name="ruleExecutionContext">Contains the schema model and model element to analyze</param>
<returns>The problems detected by the rule in the given element</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlAnalysisRule.SupportedElementTypes">
<summary>
Types of elements checked by this rule. Required if the rule scope is <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Element"/>,
for <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Model"/> scoped rules this is not relevant
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.DataTypeCompatibilityRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer">
<summary>
A type of <see cref="T:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer"/> that can be used by code analysis
rules to examine the internal structure of a <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/>.
This analyzer works against the <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/>s that represents
the exact DDL language describing an object.
This makes it easier to examine the actual script/fragment structure that represents an object.
</summary>
<remarks>
For some data sources such as dacpacs, the backing script and <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/>s
will be auto-generated by DacFx. Any analyzer that tries to enforce stylistic rules such as
blocking the use of brackets to escape object names should be disabled when running against
those sources - they would be raising issues about the default DacFx style conventions rather
than the actual code contents of a project.
</remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer"/> that helps analyze an element on behalf of a rule
</summary>
<param name="rule">
<see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor"/> defining a rule and its metadata properties.
This can be used to get the description for a rule and add it to any <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>, among other things
being created, or query any other metadata information about the rule
</param>
<param name="schemaModel">The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> being analyzed</param>
<param name="element">A specific <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> whose backing <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/>
is to be analyzed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.BeginBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.EndBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndBatch(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlBatch)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.BeginDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.EndDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndDmlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.BeginDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.BeginDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.EndDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.EndDdlStatement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.IdentifiedElement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.IdentifiedElement(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.VisitFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor,Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance)">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.VisitFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.Model.ElementDescriptor,Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.VisitAmbiguousFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor})">
<summary>
<see cref="M:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer.VisitAmbiguousFragment(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor})"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.AnalyzeScriptForSqlRule(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,System.Collections.Generic.List{Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem})">
<summary>
Runs rule analysis against a fragment and adds any problems found to the
<paramref name="problems"/> list.
</summary>
<param name="sqlFragment">A fragment whose contents should be analyzed</param>
<param name="problems">Problems found by the analyzer are added to this list</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.TryGetModelElementFromPossibilities(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor},Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject@,Microsoft.SqlServer.Dac.Model.ElementDescriptor@,Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance@)">
<summary>
Tries to determine the correct model element from a set of possible matching element descriptors.
</summary>
<param name="possibilities">Descriptors for </param>
<param name="model">The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/></param>
<param name="element">out <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> that matches the best possibility, or null if lookup failed</param>
<param name="elementDescriptor">out <see cref="T:Microsoft.SqlServer.Dac.Model.ElementDescriptor"/> for the element that was matched, or
null if the lookup failed</param>
<param name="relevance">out <see cref="T:Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance"/> describing the relavance of the
<paramref name="elementDescriptor"/> to the <paramref name="element"/></param>
<returns>true if the lookup succeeded</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.AddProblem(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem)">
<summary>
add a problem found by the current analyzer
</summary>
<param name="problem"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.ClearProblems">
<summary>
clean up all the problems
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.DebugWriteLine(System.String)">
<summary>
Print a message to debug window in Debug mode
</summary>
<param name="msg"></param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.Problems">
<summary>
Get all problems identified by this analyzer
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.SchemaModel">
<summary>
get the SQL schema manager used by the current analyzer
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.Rule">
<summary>
Get the the rule associated with the current analyzer
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.RuleSchemaAnalyzer.ModelElement">
<summary>
Get the element for which the current analyzer works
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.DataTypeCompatibilitySchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker">
<summary>
Note: This class relies on internal code that is shared with the internal validation rules. In order to minimize code
reuse and avoid unnecessarily duplicating code, some parts of this class directly use and call into the internal model.
This is viewed as acceptable as upgrading to the public API isn't really necessary and would not provide significant
benefits to external users.
In addition, some internal objects such as dynamic column sources cannot be mapped to the public model and hence
it is necessary to use the internal object model in cases where those objects might have issues
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.CollectLocalColumnDefinitions(System.Collections.Generic.Dictionary{Microsoft.SqlServer.Dac.Model.ElementDescriptor,Microsoft.SqlServer.TransactSql.ScriptDom.ColumnDefinition})">
<summary>
convert TSql.DataType to TSqlDataTypeInfo
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.CheckVariableAssignment(Microsoft.SqlServer.TransactSql.ScriptDom.VariableReference,Microsoft.Data.Tools.Schema.Sql.Common.TypeEvaluator.TSqlDataTypeInfo,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
This method is used to check variable assignment from proc/function return value to a variable
Use this if you know the type of proc/function return value
</summary>
<param name="variable"></param>
<param name="fromDataType"></param>
<param name="fragmentToReport"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.CheckAssignmentSetClause(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
we currently support
column_name = expression,
@variable = expression, and
@variable = column = expression
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.CollectParameterInfo(Microsoft.SqlServer.Dac.Model.TSqlObject,System.Collections.Generic.IList{Microsoft.SqlServer.TransactSql.ScriptDom.ExecuteParameter},Microsoft.SqlServer.Dac.Model.ModelCollationComparer,System.Collections.Generic.Dictionary{System.String,Microsoft.Data.Tools.Schema.Sql.Common.TypeEvaluator.TSqlDataTypeInfo}@,System.Collections.ObjectModel.ReadOnlyCollection{Microsoft.Data.Tools.Schema.Sql.SchemaModel.ParameterValueInfo}@)">
<summary>
Return a dictionary with parameter name key and type info value
Return a list of parameter value info that is resolved using parameters from subroutine and execute statement
</summary>
<param name="subroutine"></param>
<param name="executeParameterList"></param>
<param name="comparer"></param>
<param name="parameterNameToTypeMap"></param>
<param name="parameterValueInfo"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.TryGetParameters(Microsoft.SqlServer.Dac.Model.TSqlObject,System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Model.TSqlObject}@)">
<summary>
All object types that match a subroutine are expected to have a "Parameters" relationship which we can read.
We look up the relationship class dynamically since it will vary between Procedures, ScalarFunctions and other
types
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.TryGetReturnType(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.Data.Tools.Schema.Sql.Common.TypeEvaluator.TSqlDataTypeInfo@)">
<summary>
Attempts to look up the return type for a function
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.GetTypeInfoForInsertTarget(Microsoft.SqlServer.TransactSql.ScriptDom.InsertStatement)">
<summary>
Must use the internal model here since dynamic object column sources aren't modelable in the public model,
and this is a situation where those appear.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.GetTypeInfoForAllColumnsOfTable(Microsoft.Data.Tools.Schema.SchemaModel.IModelElement)">
<summary>
This method heavily uses the internal implementation - again this whole class struggles to use the
public model
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.GetTypeInfoForColumn(Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
Note: This method uses internal methods
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.GetTypeInfoForUdtUddt(Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
get TSqlDataTypeInfo for the acutal data type of a UDT and UDDT based on its
SqlElementDescriptor.
</summary>
<param name="uddtDescriptor">ElementDescriptor for the UDDT or UDT</param>
<returns>actual data type if found, null otherwise</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.TryGetFunctionDefinition(Microsoft.SqlServer.TransactSql.ScriptDom.FunctionCall,Microsoft.SqlServer.TransactSql.ScriptDom.FunctionStatementBody@,System.Collections.Generic.List{Microsoft.Data.Tools.Schema.Sql.Common.TypeEvaluator.TSqlDataTypeInfo}@)">
<summary>
Again we've failed to fully use the public model in this method, if this can be reviewed
at a future date then perhaps this can be fixed.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.IsAScalarModule(Microsoft.SqlServer.Dac.Model.ElementDescriptor)">
<summary>
Verifies a descriptor is a type of scalar module (ScalarFunctions and Aggregates count as this)
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.TypeCompatibilityChecker.GetTypeInfoForSequenceName(Microsoft.SqlServer.TransactSql.ScriptDom.SchemaObjectName)">
<summary>
This method heavily uses the internal implementation - again this whole class struggles to use the
public model
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.IdentitySchemaAnalyzer">
<summary>
The SchemaAnalyzer checks for the usages of system function @@IDENTITY
and reports its possibe misuse.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.IdentitySchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Constructor with SqlAnalysisRule, SqlSchemaModel, and ISqlModelElement provided
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.OldStyleJoinSyntaxAnalysisRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.OldStyleJoinSyntaxSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.PopulateOutputParametersRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.PopulateOutputParametersSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.SelectAsteriskSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Creates a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.SelectAsteriskSchemaAnalyzer"/> to analyze a particular element in the model.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.SmallVariableLengthTypesRule">
<summary>
This rule checks if a small length (less than three) is used for variable-length types,
which include VARCHAR, NVARCHAR, and VARBINARY
Such data types can be used in various scenarios:
column of regular tables
column of temporary tables
column of common table expressions
subroutine parameter
variable
scalar function return type
user defined data types
TODO, yangg: we currently dont' handle temporary table columns, cte columns, and variables,
since interpretation is not ready yet
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Design.SmallVariableLengthTypesRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Naming.ReservedWordsForTypeNameAnalysisRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Naming.ReservedWordsForTypeNameSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Constructor with comparison manager
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Naming.SpecialCharactersInObjectNameRule.DynamicObjectsLookup">
<summary>
Provides getters for the types that need to access dynamic objects - there's no clean way to do this.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Naming.SpecialCharactersInObjectNameRule.ProcessBodyScriptElements(Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject,System.Collections.Generic.IList{Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem})">
<summary>
A subset of top-level types such as Procedures have a body script containing
dynamic objects. We don't want to miss flagging errors in these, but these
aren't accessible via the public model. To work around this we use the internal
model implementation for this work
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Naming.SpPrefixForStoredProceduresRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.ExtractDeterministicFunctionCallRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.ExtractDeterministicFunctionCallSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.LikePercentRule">
<summary>
The base rule for checking LikePredicate, we suggest using "m%" instead of "%m".
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.LikePercentRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.LikePercentSchemaAnalyzer">
<summary>
This rule checks whether the patterns of the LIKE predicate from WHERE clauses start
with "%" while match expression is a column, which can cause a table scan and degrade
performance
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.LikePercentSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.ColumnInsideExpressionChecker">
<summary>
the class is to find out all the columns participating in an expression but not part of function call or ISNULL
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.MoveColumnToOneSideRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.MoveColumnToOneSideSchemaAnalyzer">
<summary>
This rule suggests moving columns to one side of en expression in the WHERE clause,
thus to avoid table scan.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.MoveColumnToOneSideSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NonIndexedColumnFromInPredicateRule">
<summary>
When we see an In Predicate, we want to check whether there is Table Index
that it could use to boost the performance. If not, we give a warning. This
is because In Predicate is executed by a Table Scan instead of Index Seek, which
hugely slows down the SQL query performance.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NonIndexedColumnFromInPredicateRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NonIndexedColumnFromInPredicateSchemaAnalyzer">
<summary>
This checks whether a column test expression of the IN predicate has an
index or not. If it does not, the evaluation of the predicate can cause
a table scan and degrade the performance.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NonIndexedColumnFromInPredicateSchemaAnalyzer.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
constructor
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NonIndexedColumnFromInPredicateSchemaAnalyzer.ColumnHasIndex(Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Check whether the specified column has index or not.
</summary>
<returns>true when the column has index; false, otherwise</returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.CheckNullableColumnHelper">
<summary>
the class is to check whether a nullable column exists in an expression
other than ISNULL function and IS NULL / IS NOT NULL operators
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NullableColumnRule">
<summary>
The base rule for Nullable Column Performance Rule.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NullableColumnRule.Analyze(Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext)">
<summary>
perform actual analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.Performance.NullableColumnSchemaAnalyzer">
<summary>
This rule is to find out all the nullable columns used in WHERE predicates which
do not act as operands of IS NULL / IS NOT NULL or arguments of ISNULL function
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute">
<summary>
Attribute defining a rule export, and the metadata about that rule. Implements ISqlAnalysisRuleMetadata,
which should be used on the importer side to ensure type consistency
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata">
<summary>
The metadata describing a rule - its namespace, id, scope etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata.Description">
<summary>
The description of the rule. This should be a short human readable description of what the
rule is intended to warn against or block.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata.RuleScope">
<summary>
The scope of this rule. Choose between <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Element"/> and <see cref="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Model"/>.
Note that for element scoped rules, the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlAnalysisRule.SupportedElementTypes"/> property must return
one or more element types that can are supported for analysis by the rule
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata.Category">
<summary>
(Optional) Category used to group the rule in Visual Studio UI. This should never be localized
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute.#ctor(System.String,System.String)">
<summary>
Constructor
</summary>
<param name="id">Unique ID used to identify this rule. Required parameter, rule will not load if this is missing or empty</param>
<param name="displayName">Display name to show in the Visual Studio UI. Required parameter, rule will not load if this is missing or empty</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute.Description">
<summary>
The description of the rule. This should be a short human readable description of what the
rule is intended to warn against or block. This field is localizable, but this should be done
be subclassing <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute"/> and overriding the Description property.
</summary>
<example>
<code>
// Example of an Attribute class that supports localized descriptions:
public class TestLocalizedExportCodeAnalysisRuleAttribute : ExportCodeAnalysisRuleAttribute
{
private readonly string _descriptionResourceName;
private string _descriptionValue;
public TestLocalizedExportCodeAnalysisRuleAttribute(string id, string displayName, string descriptionResourceName)
: base(id, displayName)
{
_descriptionResourceName = descriptionResourceName;
}
public override string Description
{
get
{
if (_descriptionValue == null)
{
// Using the descriptionResourceName as the key for looking up the description in the resources file.
// MyResources is a resource file in the same project as the LocalizedExportCodeAnalysisRuleAttribute class.
// For each rule, and entry should be added to the resources file with the descriptionResourceName as the
// key and the description as the value
_descriptionValue = MyResources.ResourceManager.GetString(_descriptionResourceName);
}
return _descriptionValue;
}
}
}
</code>
</example>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute.RuleScope">
<summary>
<see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata.RuleScope"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ExportCodeAnalysisRuleAttribute.Category">
<summary>
<see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.ISqlAnalysisRuleMetadata.Category"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.LocalizedExportCodeAnalysisRuleAttribute.GetAssembly">
<summary>
Rules in a different assembly would need to overwrite this
</summary>
<returns></returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription">
<summary>
Looks up a localized string similar to Data types of {0}({1}) and {2}({3}) are incompatible..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription_CompatibleCasting">
<summary>
Looks up a localized string similar to Expression is cast from {0} to {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription_DataLossCasting">
<summary>
Looks up a localized string similar to Data loss might occur when casting from {0} to {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription_ExplicitConversionReqruied">
<summary>
Looks up a localized string similar to Data types of {0} and {1} are not implicitly compatible. You must use the CONVERT or CAST function..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription_IncompatibleCasting">
<summary>
Looks up a localized string similar to Data types of {0} and {1} are incompatible..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_ProblemDescription_IncorrectDataType">
<summary>
Looks up a localized string similar to The following data type is not valid in this context: {0}.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.DataTypeCompatibility_RuleName">
<summary>
Looks up a localized string similar to Maintain compatibility between data types..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ExtractDeterministicFunctionCall_ProblemDescription">
<summary>
Looks up a localized string similar to Deterministic function call ({0}) might cause an unnecessary table scan..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ExtractDeterministicFunctionCall_RuleName">
<summary>
Looks up a localized string similar to Extract deterministic function calls from WHERE predicates..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.Identity_ProblemDescription">
<summary>
Looks up a localized string similar to Potential misuse of system function @@IDENTITY..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.Identity_RuleName">
<summary>
Looks up a localized string similar to Consider using SCOPE_IDENTITY instead of @@IDENTITY..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.LikePercent_ProblemDescription">
<summary>
Looks up a localized string similar to Avoid using patterns that start with "%" in LIKE predicates.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.LikePercent_RuleName">
<summary>
Looks up a localized string similar to Avoid using patterns that start with “%” in LIKE predicates..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.MoveColumnToOneside_ProblemDescription">
<summary>
Looks up a localized string similar to A column in an expression to be compared in a predicate might cause a table scan and degrade performance..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.MoveColumnToOneside_RuleName">
<summary>
Looks up a localized string similar to In the comparison, simplify the expression that includes indexed columns..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.NonIndexedColumnFromInPredicate_ProblemDescription">
<summary>
Looks up a localized string similar to A column without an index that is used as an IN predicate test expression might degrade performance..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.NonIndexedColumnFromInPredicate_RuleName">
<summary>
Looks up a localized string similar to Avoid using columns that do not have an index as test expressions in IN predicates..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.NullableColumn_ProblemDescription">
<summary>
Looks up a localized string similar to Nullable columns can cause final results to be evaluated as NULL for the predicate..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.NullableColumn_RuleName">
<summary>
Looks up a localized string similar to Use ISNULL(column, default value) on nullable columns in expressions..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.OldStyleJoinSyntax_ProblemDescription">
<summary>
Looks up a localized string similar to Old-style JOIN syntax is used..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.OldStyleJoinSyntax_RuleName">
<summary>
Looks up a localized string similar to Avoid using deprecated syntax when you join tables or views..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.PopulateOutputParameters_ProblemDescription">
<summary>
Looks up a localized string similar to Output parameter ({0}) is not populated in all code paths..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.PopulateOutputParameters_RuleName">
<summary>
Looks up a localized string similar to Specify values for output parameters in all code paths..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ReservedWordsForTypeName_FutureKeyword">
<summary>
Looks up a localized string similar to A future keyword.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ReservedWordsForTypeName_Keyword">
<summary>
Looks up a localized string similar to A keyword.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ReservedWordsForTypeName_OdbcKeyword">
<summary>
Looks up a localized string similar to An ODBC keyword.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ReservedWordsForTypeName_ProblemDescription">
<summary>
Looks up a localized string similar to {0}({1}) is used as a type name..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.ReservedWordsForTypeName_RuleName">
<summary>
Looks up a localized string similar to Avoid using reserved words for type names..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SelectAsterisk_ProblemDescription">
<summary>
Looks up a localized string similar to The shape of the result set produced by a SELECT * statement will change if the underlying table or view structure changes..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SelectAsterisk_RuleName">
<summary>
Looks up a localized string similar to Avoid SELECT * in stored procedures, views, and table-valued functions..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SmallVariableLengthTypes_OneElement">
<summary>
Looks up a localized string similar to one element.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SmallVariableLengthTypes_ProblemDescription">
<summary>
Looks up a localized string similar to Avoid {0} of only {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SmallVariableLengthTypes_RuleName">
<summary>
Looks up a localized string similar to Avoid using types of variable length that are size 1 or 2..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SmallVariableLengthTypes_TwoOrMoreElements">
<summary>
Looks up a localized string similar to {0} elements.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SpecialCharactersInObjectName_ProblemDescription">
<summary>
Looks up a localized string similar to Object name({0}) contains special characters..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SpecialCharactersInObjectName_RuleName">
<summary>
Looks up a localized string similar to Avoid using special characters in object names..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SpPrefixForStoredProcedures_ProblemDescription">
<summary>
Looks up a localized string similar to Stored procedure({0}) includes sp_ prefix in its name..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Rules.SqlRulesResourceString.SpPrefixForStoredProcedures_RuleName">
<summary>
Looks up a localized string similar to Avoid using sp_ as a prefix for stored procedures..
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.TsqlScriptDomUtils">
<summary>
Utility class for TransactSql.ScriptDom functionality. These functions will not be
part of the public API, but they may be added to the public samples project so that users can
understand how we use the ScriptDom APIs for writing rules.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.TsqlScriptDomUtils.IsSubroutineViewOrTrigger(Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
Checks if a fragment represents the body of a subroutine, a view,
or a trigger. These have similar characteristics, for instance the ability to
include select statements against tables.
</summary>
<param name="fragment"><see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/> representing part of a TSQL object definition</param>
<returns>true if this is a subroutine, a view or a trigger body</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Internal.TsqlScriptDomUtils.RemoveParenthesis(Microsoft.SqlServer.TransactSql.ScriptDom.ScalarExpression)">
<summary>
recursively remove parenthesises of an TSql parser expression
</summary>
<param name="expression">Expression to parse</param>
<returns>Expression without parenthesis</returns>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlCodeAnalysisConstants.StaticCodeAnalysisProblemCategory">
<summary>
Error category for static code analysis
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.ElementsListFormat">
<summary>
Looks up a localized string similar to {0}, {1}.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.InvalidRuleStatusPrefix">
<summary>
Looks up a localized string similar to Invalid prefix for rule key: {0}. Ignored..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.MissingSupportedElements">
<summary>
Looks up a localized string similar to Rule '{0}' in assembly '{1}' was ignored because it is missing SupportedElementTypes. This is required for Element scope rules.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.NoSupportedElementsFound">
<summary>
Looks up a localized string similar to Rule '{0}' in assembly '{1}' was ignored because it has no SupportedElementTypes that are top-level types. Only top-level types are processed during analysis. The following types were ignored: [{2}].
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.MefRuleEngineResources.UnsupportedElementsFound">
<summary>
Looks up a localized string similar to Rule '{0}' in assembly '{1}' has one or more SupportedElementTypes that are not top-level types. These following types will be ignored during analysis: [{2}].
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleEngine">
<summary>
Responsible for executing rules against a SQLModel.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleEngine.ExecuteRules(Microsoft.SqlServer.Dac.Model.TSqlModel,System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Execute all enabled rules against the specified model and each model element found in the model
</summary>
<param name="schemaModel">The model against which the rules are executed</param>
<param name="errors">The errors that occurred when executing rules</param>
<returns>The problems detected by executing the rules</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleEngine.AllRuleDescriptions">
<summary>
Used for testing purposes
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleEngine.ModelRuleDescriptions">
<summary>
Used for testing purposes
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleEngine.ElementRuleDescriptions">
<summary>
Used for testing purposes
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1.CreateStandardProperties">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties"/> that uses standard extension lookup
properties and returns this to the caller
</summary>
<returns><see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties"/></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1.SetRuleStoreFactory(Microsoft.SqlServer.Dac.CodeAnalysis.Engine.IRuleStoreFactory{`0})">
<summary>
For testing purposes only - injects a new rulestore factory for use when finding rules
</summary>
<param name="factory"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties)">
<summary>
Initializes the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1"/>
</summary>
<param name="engineProperties"><see cref="T:Microsoft.SqlServer.Dac.Extensibility.CompositionProperties"/> defining how rules should be loaded</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1.GetAllRules(System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Gets all rules.
</summary>
<param name="typeLoadErrors">Output <see cref="T:System.Collections.Generic.List`1"/> containing all errors that occurred during load. This will include general load errors
for all contributors on the machine, plus load errors relating to version mismatch between requested contributor version
and the available contributors on the machine</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleLoader`1.CreateRuleEngine(System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Creates a RuleEngine.
</summary>
<param name="errors">Errors found while processing rules - are there duplicate rules or rules that do not include required metadata</param>
<returns></returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.IRuleStore">
<summary>
A RuleStore that stores analysis rules and their metadata. Rules are accessible in their original form
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.IRuleStore.GetRuleDescriptors(System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Gets the Code Analysis rules and their metadata wrapped inside RuleDescriptorImpl objects. The EngineProperties are used to
filter rules by platform and to run a rule descriptor updater (if present), which can flag the rule as enabled/disabled
and update the severity
</summary>
<param name="errors">Errors found while processing rules - are there duplicate rules or rules that do not include required metadata</param>
<returns></returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleStore">
<summary>
For now only ISqlCodeAnalysisRule is supported via MEF - can change in the future if other rule types are required.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleStore.GetRuleDescriptors(System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Gets the Code Analysis rules and their metadata wrapped inside RuleDescriptorImpl objects. The EngineProperties are used to
filter rules by platform and to run a rule descriptor updater (if present), which can flag the rule as enabled/disabled
and update the severity
</summary>
<param name="errors">Errors found while processing rules - are there duplicate rules or rules that do not include required metadata</param>
<returns></returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.IRuleStoreFactory`1">
<summary>
Factory for loading rules via MEF extensibility.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.IRuleStoreFactory`1.CreateRuleStore(Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties,System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Creates an IRuleStore with rules found by MEF
</summary>
<param name="properties">Properties defining the configuration for extensibility loading etc</param>
<param name="errors">Errors found while loading rule extensions </param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.RuleStoreFactory`1.SetExtensionManagerFactory(Microsoft.SqlServer.Dac.Extensibility.IExtensionManagerFactory)">
<summary>
For testing purposes only - injects a new IExtensionManagerFactory which supplies types
</summary>
<param name="factory"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.SourceCodePositionProvider.TryGetSourceInformation(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.SourceInformation@)">
<summary>
Tries to find source information for a given TSqlObject
</summary>
<returns>true if source information was found</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.SourceCodePositionProvider.TryGetSourceInformation(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment,Microsoft.SqlServer.Dac.SourceInformation@)">
<summary>
Tries to find source information for a given TSqlObject
</summary>
<returns>true if source information was found</returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext">
<summary>
The context information for suppressing a SCA problem
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext.#ctor(Microsoft.SqlServer.Dac.CodeAnalysis.RuleDescriptor,Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem,Microsoft.SqlServer.Dac.Model.TSqlModel)">
<summary>
Initialize a new instance of SqlRuleProblemSuppressionContext
</summary>
<param name="rule">The Rule detecting the problem</param>
<param name="problem">The problem</param>
<param name="schemaModel">The Schema Model being analyzed</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext.ModelElement">
<summary>
The element for which a problem was discovered
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext.SchemaModel">
<summary>
The Schema Model the rule is checking against
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext.Problem">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/> discovered by an analysis rule
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSuppressionContext.Rule">
<summary>
The Rule detecting the problem
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties">
<summary>
Properties to use when creating a rules engine.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties.RuleSettingsString">
<summary>
Optional string that can be used to disable rules
and set rule severity
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties.SuppressProblem">
<summary>
The predicate to suppress problems detected by a rule against an element
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.Engine.EngineProperties.ExecuteCanceled">
<summary>
Callback function that tests whether to abort executing rules
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysis_ModelIsNotScriptBacked">
<summary>
Looks up a localized string similar to Static Code Analysis: Some rules may not run as expected because the model being analyzed does not contain scripts representing your schema objects. When analyzing code from a data source such as a Dacpac it is recommended that the source should be loaded as script-backed model to ensure correct rule operation.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_Error">
<summary>
Looks up a localized string similar to Error.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_InvalidElement">
<summary>
Looks up a localized string similar to {0} elements are in an error state.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_MultipleProblemsFound">
<summary>
Looks up a localized string similar to Static Code Analysis: {0} problems have been detected..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_NoProblemsFound">
<summary>
Looks up a localized string similar to Static Code Analysis: No problems have been detected..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_OneProblemFound">
<summary>
Looks up a localized string similar to Static Code Analysis: One problem has been detected..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_ProblemFormat">
<summary>
Looks up a localized string similar to {0}: {1}.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.CodeAnalysisTask_ResultsSavedIn">
<summary>
Looks up a localized string similar to The results are saved in {0}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.SqlCodeAnalysisTask_Unknown">
<summary>
Looks up a localized string similar to Unknown.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.ScaResources.SqlCodeAnalysisTask_Warning">
<summary>
Looks up a localized string similar to Warning.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext">
<summary>
Defines the fields necessary for analysis, including the schema model and
model element to analyze.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext.SchemaModel">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> being analyzed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext.ModelElement">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> being analyzed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext.RuleDescriptor">
<summary>
Describes the rule being executed, and can be used to access the
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext.ScriptFragment">
<summary>
Gets the script fragment which defines the element being analyzed, if this is available.
May be null.
Tries to get the most suitable <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/> for use during the rule analysis process.
If the TSqlObject was originally built from a scripted source then the original source fragment will be returned.
Otherwise a new AST will be generated from the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleExecutionContext.ModelElement"/>/>.
This ensures that when reporting <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>s the most accurate source information can be included
in the error messages.
</summary>
<remarks>
See <see cref="M:Microsoft.SqlServer.Dac.TSqlModelUtils.TryGetFragmentForAnalysis(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment@)"/> for implementation details
</remarks>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem">
<summary>
Describes a problem found by a rule during analysis. Contains relevant information
such as the Rule that found the problem, the SqlObject causing the problem,
the severity, and the error message to display.
Source position information (source name, start line and column) are initially inferred based on
the <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.ModelElement"/> and <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Fragment"/> passed into the constructor. Note that if
a <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Fragment"/> is passed in then the start line/column for that <see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/>
will be used (if present), otherwise the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/>'s values will be used (if present).
Note that certain models such as those generated from a dacpac may not have source position
information.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.#ctor(System.String,Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Constructs a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>. Source position information
(source name, start line and column) is inferred based on the <paramref name="modelElement"/>
parameter, as long as this information is present in the model.
</summary>
<param name="description">Description of the problem</param>
<param name="modelElement">The element that caused the problem </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.#ctor(System.String,Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment)">
<summary>
Constructs a new <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>. Source position information
(source name, start line and column) is inferred based on the <paramref name="modelElement"/>
and <paramref name="fragment"/> parameters, as long as this information is present in the model.
</summary>
<param name="description">Description of the problem</param>
<param name="modelElement">The element that caused the problem</param>
<param name="fragment"><see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/> specifying the precise </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.SetSourceInformation(Microsoft.SqlServer.Dac.SourceInformation)">
<summary>
Sets source position information (source name, start line and column) for this <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>,
overriding any position information inferred when the rule was created.
</summary>
<param name="sourceInformation"><see cref="T:Microsoft.SqlServer.Dac.SourceInformation"/> specifying the values to set for the
<see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.SourceName"/>, <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.StartLine"/> and <see cref="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.StartColumn"/> fields</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Rule">
<summary>
Description of the rule used to detect the current problem. Does not need to be set by the rule itself
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.RuleId">
<summary>
Id of the rule that created this <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.ModelElement">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> causing the current problem
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Fragment">
<summary>
<see cref="T:Microsoft.SqlServer.TransactSql.ScriptDom.TSqlFragment"/> causing the problem
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Description">
<summary>
Problem description
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.Severity">
<summary>
The severity of this problem, can be error, warning.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.ErrorMessageString">
<summary>
The string for displaying the error message, based on rule information
and the problem description
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.SourceName">
<summary>
Name of the source this problem was found in. This is determined based on the
model element passed into the constructor. May be null if no source information
was available. For instance models loaded from Dacpac files may not have source
information available
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.StartLine">
<summary>
The line the problem begins at, if known
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblem.StartColumn">
<summary>
The column the problem begins at, if known
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity">
<summary>
The type of message for reporting problems
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Unknown">
<summary>
Unknown severity
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Warning">
<summary>
Warning
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleProblemSeverity.Error">
<summary>
Error
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope">
<summary>
The scope examined by a static code analysis rule.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Element">
<summary>
The rule examines a single element.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.CodeAnalysis.SqlRuleScope.Model">
<summary>
The rule examines the entire model.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo">
<summary>
Information about a problem being suppressed for a particular source.
This information includes the source name and the rule whose problems should be suppressed.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo.#ctor(System.String,Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration)">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo"/> for a given source name and rule
</summary>
<param name="sourceName">
Name of the source to be suppressed. This is commonly the path to a file on disk.
</param>
<param name="rule">Information about the rule whose problems should be suppressed</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo.Equals(System.Object)">
<summary>
<see cref="M:System.Object.Equals(System.Object)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo.GetHashCode">
<summary>
<see cref="M:System.Object.GetHashCode"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo.SourceName">
<summary>
Gets the name of the source to be suppressed. This is commonly the path to a file on disk.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.CodeAnalysis.SuppressedProblemInfo.Rule">
<summary>
Gets a <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.RuleConfiguration"/> with information about the rule
whose problems should be suppressed
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.DacSchemaComparisonMessage">
<summary>
Represents a problem encountered during schema comparison.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.DacSchemaComparisonMessage.Exception">
<summary>
Exception associated with the error, or null
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.ComparisonResultStateDoesNotAllowPublish">
<summary>
Looks up a localized string similar to Performing publish is not possible for this comparison result..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.ComparisonResultStateDoesNotAllowScriptGeneration">
<summary>
Looks up a localized string similar to Performing script generation is not possible for this comparison result..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.InvalidConnectionString">
<summary>
Looks up a localized string similar to The specified connection string is not valid..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToAnUnexpectedException">
<summary>
Looks up a localized string similar to The operation failed..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToException0">
<summary>
Looks up a localized string similar to The operation failed. The error was: {0}.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToSourceDrift">
<summary>
Looks up a localized string similar to The operation could not continue because the source database was modified after schema comparison was completed..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToSourceModelErrors">
<summary>
Looks up a localized string similar to The operation could not continue because the source model contains errors..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToTargetDrift">
<summary>
Looks up a localized string similar to The operation could not continue because the target database was modified after schema comparison was completed..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.OperationFailedDueToTargetModelErrors">
<summary>
Looks up a localized string similar to The operation could not continue because the target model contains errors..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.Path0DoesntContainValidScmpFile">
<summary>
Looks up a localized string similar to The path '{0}' does not contain a valid schema compare file (.scmp file)..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.SchemaComparisonOnlySupportsDacpacAndDatabase">
<summary>
Looks up a localized string similar to SchemaComparison only supports database and dacpac endpoint types..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.UnableToDeserializeScmpFile">
<summary>
Looks up a localized string similar to The specified file could not be opened as a schema comparison file. The file might be corrupt or it might refer to a target or source endpoint that is not of type database or dacpac. Only database endpoints and dacpac endpoints are supported..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareApiResources.UpdateScriptsForDacpacsRequireDbName">
<summary>
Looks up a localized string similar to A non-empty database name must be specified in order to generate an update script for a SchemaCompareDacpacEndpoint..
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint">
<summary>
Refers to a source or target for schema comparison
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareDacpacEndpoint">
<summary>
Refers to a dacpac file as either a source or target for schema comparison
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaCompareDacpacEndpoint.#ctor(System.String)">
<summary>
Constructs a schema compare endpoint that refers to a dacpac file
</summary>
<param name="dacpacFilePath">Path to a dacpac file</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareDacpacEndpoint.FilePath">
<summary>
The dacpac file path
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareDatabaseEndpoint">
<summary>
Refers to a database as either a source or target for schema comparison
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaCompareDatabaseEndpoint.#ctor(System.String)">
<summary>
Constructs a schema compare endpoint that refers to a database
</summary>
<param name="connectionString">A connection string to a database instance</param>
<exception cref="T:System.ArgumentNullException">The supplied connection string is null.</exception>
<exception cref="T:System.FormatException">Invalid value within the connection string (for example, when a Boolean or numeric value was expected but not supplied).</exception>
<exception cref="T:System.ArgumentException">The supplied connectionString is not valid.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaCompareDatabaseEndpoint.#ctor(System.String,System.Security.SecureString)">
<summary>
Constructs a schema compare endpoint that refers to a database
</summary>
<param name="connectionString">A connection string to a database instance</param>
<param name="password"><see cref="T:System.Security.SecureString"/> that supplies the password for the database connection used by this instance.</param>
<exception cref="T:System.ArgumentNullException">The supplied connection string or password is null.</exception>
<exception cref="T:System.FormatException">Invalid value within the connection string (for example, when a Boolean or numeric value was expected but not supplied).</exception>
<exception cref="T:System.ArgumentException">The supplied connectionString is not valid.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaCompareDatabaseEndpoint.#ctor(Microsoft.Data.Tools.Schema.Common.SqlClient.SqlConnectionFactory)">
<summary>
Constructs a schema compare endpoint that refers to a database
</summary>
<param name="connectionFactory">A connection string to a database instance</param>
<exception cref="T:System.ArgumentNullException">The supplied connection factory is null.</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareDatabaseEndpoint.DatabaseName">
<summary>
The database name
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaComparison">
<summary>
Class that allows comparing schema between two types of entities: databases and dacpac files
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparison.#ctor(System.String)">
<summary>
SchemaComparison constructor that uses a schema compare file (.scmp file) for
all comparison settings. Only dacpac and/or database endpoints may be compared.
</summary>
<param name="scmpFilePath">The path to a schema compare file (.scmp file)</param>
<exception cref="T:System.ArgumentException">If either the source or the target endpoint is neither a database nor a dacpac file.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparison.#ctor(Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint,Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint)">
<summary>
SchemaComparison constructor that takes endpoints that specify the source and target for comparison.
</summary>
<param name="source">A <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint"/> that refers to a schema source.</param>
<param name="target">An <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint"/> that refers to a target. Comparison will update the target to match the source.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparison.Compare">
<summary>
Performs schema comparison, populating comparison results.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparison.SaveToFile(System.String,System.Boolean)">
<summary>
Saves the SchemaComparison as an scmp file.
</summary>
<param name="filePath"></param>
<param name="overwrite">When true, any existing file at filePath will be overwritten. If false, save will throw an
IOException if a file already exists at filePath.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparison.SaveToStream(System.IO.Stream)">
<summary>
Saves the SchemaComparison as an scmp file into a stream
</summary>
<param name="stream">A stream that supports writing.</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparison.Source">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint"/> that refers to a schema source.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparison.Target">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareEndpoint"/> that refers to a target. Comparison will update the target to match the source.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparison.ExcludedSourceObjects">
<summary>
Elements in the source database model to exclude from comparison.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparison.ExcludedTargetObjects">
<summary>
Elements in the target database model to exclude from comparison.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparison.Options">
<summary>
Options that affect the behavior of package deployment.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaDifferenceType">
<summary>
Represents the different possible types of <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaDifference"/>
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Compare.SchemaDifferenceType.Object">
<summary>
A model object (for example: column, parameter)
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Compare.SchemaDifferenceType.Property">
<summary>
A property of a model object (for example: Name, Collation)
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult">
<summary>
Class that provides information about the differences between a source and target database.
Differences are represented in a tree structure.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.Include(Microsoft.SqlServer.Dac.Compare.SchemaDifference)">
<summary>
Used to try to include a difference as part of the set of update actions that are scripted or published.
</summary>
<param name="node">The tree node to (possibly) modify</param>
<returns>Returns true if, after completion, the node's state is included</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.Exclude(Microsoft.SqlServer.Dac.Compare.SchemaDifference)">
<summary>
Used to try to exclude a difference as part of the set of update actions that are scripted or published.
</summary>
<param name="node">The tree node to (possibly) modify</param>
<returns>Returns true if, after completion, the node's state is not included</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.GetErrors">
<summary>
Provides an enumeration of errors that prevent successful schema compare operations.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.GenerateScript(System.String)">
<summary>
Generates a T-SQL update script that makes the target schema consistent with the source schema.
</summary>
<param name="databaseName">The name of the target database.</param>
<returns>SchemaCompareScriptGenerationResult </returns>
<exception cref="T:System.ArgumentException">If the target is a dacpac and a null or empty databaseName value was provided.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.PublishChangesToTarget">
<summary>
Generates and then executes a T-SQL update script that makes the target schema consistent with the source schema.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.IsValid">
<summary>
Indicates whether comparison resulted in a valid, usable result
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.IsEqual">
<summary>
Indicates whether the source and target endpoints are equal
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.SourceModel">
<summary>
The source database model
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.TargetModel">
<summary>
The target database model
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonResult.Differences">
<summary>
A tree that contains results of schema comparison of source and target endpoints.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult">
<summary>
Result of generating scripts
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult.Script">
<summary>
The generated script
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult.MasterScript">
<summary>
When needed (e.g. for Azure SQL Database), a separate script to be executed against the master database on the target server
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult.Success">
<summary>
Indicates whether generating the script was successful.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult.Message">
<summary>
Provides context information in the event of an error.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaCompareScriptGenerationResult.Exception">
<summary>
Provides error information in the event of an exception.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaComparePublishResult">
<summary>
Result of publishing comparison result
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparePublishResult.Script">
<summary>
The generated script
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparePublishResult.MasterScript">
<summary>
When needed (e.g. for Azure SQL Database), a separate script to be executed against the master database on the target server
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparePublishResult.Success">
<summary>
Indicates whether generating the script was successful.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparePublishResult.Errors">
<summary>
Any errors encountered while publishing
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaDifference">
<summary>
Represents an object or property difference found during comparison of two database models.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.DifferenceType">
<summary>
Represents the type of this <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaDifference"/> node
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.UpdateAction">
<summary>
The update action required to make the schema of the target equal to the source schema.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.Included">
<summary>
Indicates whether this node and all of its children will be included during script generation or publish of the comparison result.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.IsExcludable">
<summary>
Indicates whether this node can be excluded from script generation and publish of the comparison result.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.Parent">
<summary>
The parent difference (of type <see cref="F:Microsoft.SqlServer.Dac.Compare.SchemaDifferenceType.Object"/>), if any, of this difference
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.Children">
<summary>
Object or property differences, if any, that relate to this difference.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.SourceObject">
<summary>
Object from the source database model
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.TargetObject">
<summary>
Object from the target database model
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaDifference.Name">
<summary>
Node name
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId">
<summary>
Represents an object by name and type for use in <see cref="T:Microsoft.SqlServer.Dac.Compare.SchemaComparison"/> operations.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.#ctor(Microsoft.SqlServer.Dac.Model.ModelTypeClass,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Constructs an identifier that refers to an object by type and name.
</summary>
<param name="typeClass">The type of an object</param>
<param name="identifier">The ObjectIdentifier (name) of an object</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.#ctor(Microsoft.SqlServer.Dac.Model.ModelTypeClass,Microsoft.SqlServer.Dac.Model.ObjectIdentifier,Microsoft.SqlServer.Dac.Model.ModelTypeClass,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Constructs an identifier that refers to an object by type and name.
</summary>
<param name="typeClass">The type of an object</param>
<param name="identifier">The ObjectIdentifier (name) of an object</param>
<param name="parentTypeClass">The type of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.</param>
<param name="parentIdentifier">The name of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.#ctor(System.String,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Constructs an identifier that refers to an object by type and name.
</summary>
<param name="typeName">The type name used by schema comparison</param>
<param name="identifier">The possibly null ObjectIdentifier (name) of an object</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.#ctor(System.String,Microsoft.SqlServer.Dac.Model.ObjectIdentifier,System.String,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Constructs an identifier that refers to an object by type and name.
</summary>
<param name="typeName">The type name used by schema comparison</param>
<param name="identifier">The possibly null ObjectIdentifier (name) of an object</param>
<param name="parentTypeName">The type name of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.</param>
<param name="parentIdentifier">The name of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.TypeName">
<summary>
The type name used by schema comparison
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.Identifier">
<summary>
Specifies the name of an object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.ParentTypeName">
<summary>
The type name of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Compare.SchemaComparisonExcludedObjectId.ParentIdentifier">
<summary>
Specifies the name of the parent object. This is used to refer to an unnamed object by reference to its (named) parent.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Compare.SchemaUpdateAction">
<summary>
Represents a schema update action
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Compare.SchemaUpdateAction.Delete">
<summary>
Delete - removing an object from the database
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Compare.SchemaUpdateAction.Change">
<summary>
Change - modifying an object in the database
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Compare.SchemaUpdateAction.Add">
<summary>
Add - adding an object to the database
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.DacPackageExtensions">
<summary>
Provides extension methods to support manipulation of DacPackage objects.
These extension methods work on an existing <see cref="T:Microsoft.SqlServer.Dac.DacPackage"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.DacPackageExtensions.UpdateModel(Microsoft.SqlServer.Dac.DacPackage,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata)">
<summary>
Updates the model in a <see cref="T:Microsoft.SqlServer.Dac.DacPackage"/>, replacing the current model with a new one.
Before updating, the model will be validated and if errors are encountered a <see cref="T:Microsoft.SqlServer.Dac.DacServicesException"/>
will be thrown. If callers wish to block on warnings as well as errors, they must validate the model by calling
<see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.Validate"/> and checking if any errors or warnings are included in the messages returned.
Note: only the model is replaced - all other artifacts such as refactor log, pre-deployment script,
post-deployment script and and contributor artifacts are not altered. If any of these artifacts
rely on elements that are no longer in the updated model then deployment may fail. It is the
responsibility of the caller to ensure that these artifacts are consistent with the new model.
The <see cref="T:System.IO.Packaging.Package"/> API can be used to update other artifacts such as the refactor log and scripts
and keep them consistent with the updated model.
These artifacts are stored as package parts and are identified by their URI.
Package parts can be examined using <see cref="M:System.IO.Packaging.Package.GetParts"/>. Please refer to the
<see cref="T:System.IO.Packaging.Package"/> API for further information about updating package parts.
</summary>
<param name="dacPackage"><see cref="T:Microsoft.SqlServer.Dac.DacPackage"/> to be updated</param>
<param name="newModel"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> representing the model to save into the package.</param>
<param name="packageMetadata"><see cref="T:Microsoft.SqlServer.Dac.PackageMetadata"/> describing the name, version and description to use
for the <see cref="T:Microsoft.SqlServer.Dac.DacPackage"/>, or null if the package information should remain the same. </param>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If the <see cref="T:Microsoft.SqlServer.Dac.DacPackage"/> contains data.</exception>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If there are any errors saving the model to the package,
including errors validating the model.
</exception>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If the <paramref name="dacPackage"/> was not loaded with <see cref="F:System.IO.FileAccess.ReadWrite"/>.</exception>
<exception cref="T:System.ArgumentNullException">If the <paramref name="dacPackage"/> or <paramref name="newModel"/> parameters are null.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.DacPackageExtensions.BuildPackage(System.String,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata)">
<summary>
Creates a package with the specified <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> and saves it to the specified location.
</summary>
<param name="packageFilePath">Path to the package file.</param>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> representing the model to save into the package.</param>
<param name="packageMetadata">Metadata information that describes the package.</param>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If there are any errors during package serialization, including errors validating the model.</exception>
<exception cref="T:System.ArgumentNullException">If the <paramref name="packageFilePath"/> or <paramref name="model"/> parameters are null.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.DacPackageExtensions.BuildPackage(System.String,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata,Microsoft.SqlServer.Dac.PackageOptions)">
<summary>
Creates a package with the specified <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> and saves it to the specified location.
In addition to the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>, other artifacts such as refactor log and deployment contributors can be specified in <paramref name="packageOptions"/>.
</summary>
<param name="packageFilePath">Path to the package file.</param>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> representing the model to save into the package.</param>
<param name="packageMetadata">Metadata information that describes the package.</param>
<param name="packageOptions"><see cref="T:Microsoft.SqlServer.Dac.PackageOptions"/> defining advanced options and additional artifacts.</param>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If there are any errors during package serialization, including errors validating the model.</exception>
<exception cref="T:System.ArgumentNullException">If the <paramref name="packageFilePath"/> or <paramref name="model"/> parameters are null.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.DacPackageExtensions.BuildPackage(System.IO.Stream,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata)">
<summary>
Creates a package with the specified <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> and saves it to the specified <see cref="T:System.IO.Stream"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the package content will be serialized.</param>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> representing the model to save into the package.</param>
<param name="packageMetadata">Metadata information that describes the package.</param>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If there are any errors during package serialization, including errors validating the model.</exception>
<exception cref="T:System.ArgumentNullException">If the <paramref name="stream"/> or <paramref name="model"/> parameters are null.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.DacPackageExtensions.BuildPackage(System.IO.Stream,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata,Microsoft.SqlServer.Dac.PackageOptions)">
<summary>
Creates a package with the specified <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> and saves it to the specified <see cref="T:System.IO.Stream"/>.
In addition to the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>, other artifacts such as refactor log and deployment contributors can be specified in <paramref name="packageOptions"/>.
</summary>
<param name="stream"><see cref="T:System.IO.Stream"/> to which the package content will be serialized.</param>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> representing the model to save into the package.</param>
<param name="packageMetadata">Metadata information that describes the package.</param>
<param name="packageOptions"><see cref="T:Microsoft.SqlServer.Dac.PackageOptions"/> defining advanced options and additional artifacts.</param>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">If there are any errors during package serialization, including errors validating the model.</exception>
<exception cref="T:System.ArgumentNullException">If the <paramref name="stream"/> or <paramref name="model"/> parameters are null.</exception>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.BuildContributor">
<summary>
Derivatives of the BuildContributor extension are executed during a
project build after the project's model has been constructed and verified.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.BuildContributor.OnExecute(Microsoft.SqlServer.Dac.Deployment.BuildContributorContext,System.Collections.Generic.IList{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError})">
<summary>
Called after the project's model has been completely built giving the build
contributor an opportunity to examine the model and possible output
additional files.
</summary>
<param name="context"><see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext"/> object</param>
<param name="messages">Any messages to be published as part of the build process can be added to this List.
May relate to errors or can also be informational</param>
<exception cref="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException">This type of exception should be thrown if the build cannot continue.</exception>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext">
<summary>
Provides the context for the build process that is used by <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributor"/> objects
during project build. See documentation for the <see cref="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.Arguments"/> and <see cref="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.ExtensionFiles"/>
properties for information on how to specify these inside a project file.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.#ctor(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,System.String},Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.Build.Framework.ITaskItem[])">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext"/> class.
</summary>
<param name="buildProperties">A <see cref="T:System.Collections.Generic.Dictionary`2"/> of named property values. Canno be null</param>
<param name="arguments">A <see cref="T:System.Collections.Generic.Dictionary`2"/> of command-line arguments and values. Cannot be null.</param>
<param name="buildModel">A reference to the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> of the project. Cannot be null.</param>
<param name="extensionFiles">An array of <see cref="T:Microsoft.Build.Framework.ITaskItem"/> objects.</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.BuildProperties">
<summary>
Gets a dictionary of named properties and their values
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.Arguments">
<summary>
Gets a dictionary of command-line arguments and their values.
When building in SSDT, arguments are available when found in a .sqlproj file or a referenced .targets file.
For instance to add a "RunMyContributor" argument with a value of
"true", the following would be added:
<PropertyGroup>
<ContributorArguments Condition="'$(Configuration)' == 'Debug''">
$(ContributorArguments);RunMyContributor=True;
</ContributorArguments>
</PropertyGroup>
In this case the argument is only added for Debug configuration.
Using the above configuration it is possible to collect information from the MSBuild environment
and pass it to the contributor.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.Model">
<summary>
Gets the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> of the project
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.BuildContributorContext.ExtensionFiles">
<summary>
Gets an array of <see cref="T:Microsoft.Build.Framework.ITaskItem"/> representing
Files from the project system which influence the build contributors.
Input configuration files can be defined in a .sqlproj file as part of the MSBuild process.
Inside a .sqproj file, Build Configuration files are specified as follows:
<ItemGroup>
<BuildExtensionConfiguration Include="MyContributorName.MyFileName1.sql" />
<BuildExtensionConfiguration Include="MyContributorName.MyFileName2.sql" />
</ItemGroup>
Note that configuration files are accessible to all contributors. Contributors may employ a
file naming pattern to identify which input files related to that contributor.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException">
<summary>
A BuildFailedException should be thrown to indicate that the build cannot continue.
This will stop the build process.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.BuildFailedException.#ctor(System.String)">
<summary>
Constructs a <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException"/> with a string exception message
</summary>
<param name="message">string describing the cause of the failure</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.BuildFailedException.#ctor(System.String,System.Exception)">
<summary>
Constructs a <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException"/> with a string exception message
and an inner <see cref="T:System.Exception"/> providing more information about the failure
</summary>
<param name="message">string describing the cause of the failure</param>
<param name="innerException"><see cref="T:System.Exception"/> that is the root cause of the failure</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration">
<summary>
Instances of this class are created by Build and Deployment contributors during design-time to
initialize arguments that are passed to them at runtime.
In SSDT, these arguments must be specified using a ContributorArguments property
in a .sqlproj file or a referenced .targets file. For instance to add a "RunMyContributor" argument with a value of
"true", the following would be added:
<PropertyGroup>
<ContributorArguments Condition="'$(Configuration)' == 'Debug''">
$(ContributorArguments);RunMyContributor=True;
</ContributorArguments>
<PropertyGroup>
In this case the argument is only added for Debug configuration.
Using the above configuration it is possible to collect information from the MSBuild environment
and pass it to the contributor.
It is also possible to specify these when creating a package by using <see cref="M:Microsoft.SqlServer.Dac.DacPackageExtensions.BuildPackage(System.String,Microsoft.SqlServer.Dac.Model.TSqlModel,Microsoft.SqlServer.Dac.PackageMetadata,Microsoft.SqlServer.Dac.PackageOptions)"/>
and specifying <see cref="T:Microsoft.SqlServer.Dac.PackageOptions"/>.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration"/> class.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration"/> class.
</summary>
<param name="name">The name of the argument.</param>
<param name="value">The value of the argument.</param>
<exception cref="T:System.ArgumentNullException">If the <paramref name="name"/> or <paramref name="value"/> parameters are null</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration.Name">
<summary>
Gets or sets the name of the argument.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ContributorArgumentConfiguration.Value">
<summary>
Gets or sets the value of the argument expressed as a string.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream">
<summary>
Represents a streamable version of a configuration file that is used by DacFx in the deployment and build processes.
These streams enable deployment extensions to enhance and extend the design and deployment experience.
Input configuration files can be defined in a .sqlproj file as part of the MSBuild process.
The files are treated as streams, and will be passed to contributors
via the <see cref="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.EstablishDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup)"/> method, where they can
be copied as outputs that are stored in the generated dacpac.
These streams will then be made available
in the <see cref="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.ApplyDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext,System.Collections.Generic.ICollection{Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream})"/>, where they can be
consumed for configuration and data during deployment. At the end of the
<see cref="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.ApplyDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext,System.Collections.Generic.ICollection{Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream})"/> method all streams will be disposed.
Contributors that need to obtain data from the streams must read and cache the data during this method -
attempts to read from the stream during the <see cref="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor.OnExecute(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext)"/> method
will fail.
Inside a .sqproj file, Deployment Configuration files are specified as follows:
<ItemGroup>
<DeploymentExtensionConfiguration Include="MyContributorName.MyFileName1.sql" />
<DeploymentExtensionConfiguration Include="MyContributorName.MyFileName2.sql" />
</ItemGroup>
Note that configuration streams are accessible to all contributors. Contributors may employ a
file naming pattern to identify which input files related to that contributor.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream.#ctor(System.String)">
<summary>
Creates an instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream"/>
</summary>
<param name="filePath">A file path for which a stream can be created</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream.GetStream">
<summary>
Gets the <see cref="T:System.IO.Stream"/>
</summary>
<returns><see cref="T:System.IO.Stream"/></returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream.Filename">
<summary>
The filename used to represent this stream
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorInformation">
<summary>
Information that identifies a deployment contributor
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorInformation.ExtensionId">
<summary>
Id of the extension that implements the
deployment contributor
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorInformation.Version">
<summary>
Version of the deployment contributor extension (optional).
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal">
<summary>
Base class for implementing deployment step types.
It should not be used for writing extensions. Extensions
must directly implement DeploymentStep
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep">
<summary>
Represents a step in a deployment plan.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStep.ToString">
<summary>
Returns a string that describes this step. The base returns the
type of the step
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStep.GenerateTSQL">
<summary>
Returns a list of strings that represent a set of TSQL script batches to be applied
during deployment
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStep.GenerateBatchScript(System.IO.TextWriter)">
<summary>
Helper that writes the set of batch scripts to the provided writer
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentStep.Next">
<summary>
Gets the next step in the container, which is a <see cref="T:System.Collections.Generic.LinkedListNode`1"/> of type DeploymentStep.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentStep.Previous">
<summary>
Gets the previous step in the container, which is a <see cref="T:System.Collections.Generic.LinkedListNode`1"/> of type DeploymentStep.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal.#ctor">
<summary>
Internal custructor as class is meant for internal purpose
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal.#ctor(Microsoft.Data.Tools.Schema.Sql.Deployment.DeploymentStep)">
<summary>
Internal custructor as class is meant for internal purpose
</summary>
<param name="internalStep"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal.GenerateTSQL">
<summary>
Returns a list of strings that represent a set of TSQL script batches to be applied
during deployment
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentStepInternal.ToString">
<summary>
Returns a string that describes this step. The base returns the
type of the step
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.AlterElementStep">
<summary>
A step in a deployment plan that represent an alter to an element.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep">
<summary>
Base class for script based deployment steps.
Represents a deployment step that consists of an Abstract Syntax Tree (AST) and reference to a script Domain Object Model (DOM) generator.
This class is for read-only purpose.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep.Message">
<summary>
Gets an optional message describing the step
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep.IsMessageInFirstBatch">
<summary>
Returns true if the step's message will be the first batch when calling
GenerateTSql()
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep.Script">
<summary>
Gets the script for this step.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptDomStep.ScriptGenerator">
<summary>
Gets the ScriptGenerator for this step
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.AlterElementStep.SourceElement">
<summary>
Get the source element in the alter step
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.AlterElementStep.TargetElement">
<summary>
Gets the target element in the alter step
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.BeginPostDeploymentScriptStep">
<summary>
A step in the deployment plan that represents script deployment at the beginning the post-deployment.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.EmptyStep">
<summary>
Represents an empty step in deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.BeginPreDeploymentScriptStep">
<summary>
A step in the deployment plan that represents script deployment at the beginning of pre-deployment.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.CreateElementStep">
<summary>
The step in a deployment plan that represents a create of an element.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.CreateElementStep.SourceElement">
<summary>
Get the source element of the create element step
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacBulkCopyStep">
<summary>
The DacBulkCopyStep uploads / streams data from the dac package to the target db.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacDeleteFromTablesStep">
<summary>
The step in deployment plan that represents delete from table.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacDropSystemVersioningStep">
<summary>
The step in deployment plan that represents drop of a temporal system-versioning clause
and system-time PERIOD.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacRestoreSystemVersioningStep">
<summary>
The step in deployment plan that represents creation of a temporal system-versioning clause
and system-time PERIOD on the appropriate temporal columns.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlAddSystemVersioningStep">
<summary>
The step in deployment plan that represents creation of a temporal system-versioning clause
and system-time PERIOD on the appropriate temporal columns.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDropSystemVersioningStep">
<summary>
The step in deployment plan that represents drop of a temporal system-versioning clause
and system-time PERIOD.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacDropTemporalSchemaBoundElementStep">
<summary>
The step in deployment plan that represents drop of an temporal table schema-bound objects
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacDisableForeignKeysStep">
<summary>
The step in deployment plan that represents disabling foreign keys.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacRestoreConstraintsStep">
<summary>
The step in deployment plan that represents restoring constraints.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DacSaveConstraintsStep">
<summary>
The step in deployment plan that represents saving constraints.
This class is for read-only purpose.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptStep">
<summary>
The step in deployment plan that represents deploying scripts.
This class can be instantiated and used by extensions.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptStep.#ctor(System.String)">
<summary>
Creates an instance of <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptStep"/>
</summary>
<param name="text">script to deploy</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptStep.#ctor(System.Collections.Generic.IEnumerable{System.String})">
<summary>
Initializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentScriptStep"/> with multiple TSQL scripts
</summary>
<param name="batches"><see cref="T:System.Collections.Generic.IEnumerable`1"/> of strings representing
TSQL scripts</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DropElementStep">
<summary>
A step in deployment step that represents dropping a sql object.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DropElementStep.TargetElement">
<summary>
Gets the target element
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.EndPostDeploymentScriptStep">
<summary>
A step in the deployment plan that represents script deployment at the end of post-deployment.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.EndPreDeploymentScriptStep">
<summary>
A step in the deployment plan that represents script deployment at the end of pre-deployment.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlBeginAltersStep">
<summary>
Instances of this class mark the portion of the deployment plan where
ALTERs (and CREATEs) are performed.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlBeginDropsStep">
<summary>
An instance of this class marks the beginning of the "drops" portion of the
deployment plan. Drops occur in the plan before Alters.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlBeginPreservationStep">
<summary>
This class marks the start (in a deployment plan) of the preservation of intent section of the
plan. These operations are ones taken to affect refactoring changes.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlBeginTransactionStep">
<summary>
This step marks the beginning of the transactional section of a deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlChangeDatabaseStep">
<summary>
The step in deployment step that represents change database.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlChangeDatabaseStep.DatabaseName">
<summary>
Gets the database name
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlCreateDatabaseStep">
<summary>
The step in deployment that represents database creation.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDropDatabaseStep">
<summary>
The step in deployment that represents database drop.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlCreateTrackingTableStep">
<summary>
The step in deployment that represents the creation of the tracking table (__ScriptTrackingLogs).
This table is used to improve the reliability of deployment to SQL Azure.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDropTrackingTableStep">
<summary>
The step in deployment that represents drop of the tracking table (__ScriptTrackingLogs).
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlEndAltersStep">
<summary>
Instances of this class mark the portion of the deployment plan where
ALTERs (and CREATEs) are completed.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlEndDropsStep">
<summary>
An instance of this class marks the end of the "drops" portion of the
deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlEndPreservationStep">
<summary>
This class marks the end (in a deployment plan) of the preservation of intent section of the
plan. These operations are ones taken to affect refactoring changes.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlEndTransactionStep">
<summary>
This step marks the end of the transactional section of a deployment script.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlFinalizeDatabaseAccessStep">
<summary>
This step is represents a step in the SQL deployment plan that finalizes the access settings to the database. These
settings include Read-Only or Read-Write access, restricted, single user or multi-user, and online versus offline.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlMoveSchemaStep">
<summary>
In the deployment plan, instances of this step represent moving the element from a previous schema to
the new one.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlMoveSchemaStep.MovedElement">
<summary>
Gets the moved element
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlMoveSchemaStep.NewSchema">
<summary>
Gets the new schema
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlMoveSchemaStep.PreviousName">
<summary>
Gets the previous name
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlPrintStep">
<summary>
A type of step in a Sql deployment plan that signifies a SQL "print" statement.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlRenameStep">
<summary>
Represents a step in the deployment plan that renames a element.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlRenameStep.RenamedElement">
<summary>
Gets the renamed object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlRenameStep.OldName">
<summary>
Gets the old name of the object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlRenameStep.NewName">
<summary>
Gets the new name of the object
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlTableMigrationStep">
<summary>
Represents a data motion step in a sql deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlTableMigrationStep.SourceTable">
<summary>
Gets the source table object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlTableMigrationStep.TargetTable">
<summary>
Gets the target table object
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionMigrationStep">
<summary>
Represents a data motion step for column encryption in a sql deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionMigrationStep.SourceTable">
<summary>
Gets the source table object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionMigrationStep.TargetTable">
<summary>
Gets the target table object
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlEnableDatabaseChangeTrackingStep">
<summary>
Represents a step which will enable change tracking on the database
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDisableDatabaseChangeTrackingStep">
<summary>
Represents a step which will disable change tracking on the database
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionSPRefreshStep">
<summary>
Represents a step which will execute sp_refresh stored procedures
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionRenameToOriginalStep">
<summary>
Represents a rename back to original step for column encryption in a sql deployment plan.
This class is for read-only purpose and cannot be instantiated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionRenameToOriginalStep.SourceTable">
<summary>
Gets the source table object
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlColumnEncryptionRenameToOriginalStep.TargetTable">
<summary>
Gets the target table object
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute">
<summary>
Concrete classes implementing <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributor"/> must add the
<see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute"/> attribute to their class definition. This ensures
they will be detected and available for use during build.
<see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributor"/>s require a unique ID which can be based on their fully qualified type name, or explicitly
passed as a string
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute.#ctor(System.String,System.String)">
<summary>
Initializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute"/>
</summary>
<param name="id">Unique Id used to identify the export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute.#ctor(System.Type,System.String)">
<summary>
Intializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportBuildContributorAttribute"/>
</summary>
<param name="implementingType">The Concrete type that extends <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildContributor"/> - this is used
to generate the unique Id for this Export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanExecutor">
<summary>
This class represents a deployment constributor that executes the deployment plan. An
example of a constributor would be one who executes deployment steps to create a
report about actions performed during a deployment
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor">
<summary>
Represents a contributor to the deployment process
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor">
<summary>
The base class for deployment contributors. Subclasses of this class
participate in a deployment by modifying a deployment plan or by executing
the plan
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor"/> class.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.Dispose">
<summary>
Inherited from <see cref="M:System.IDisposable.Dispose"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.Dispose(System.Boolean)">
<summary>
</summary>
<param name="disposing"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.PublishMessage(Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError)">
<summary>
Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers.
</summary>
<param name="message">A <see cref="T:Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError"/> that contains the message to publish</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.OnEstablishDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup)">
<summary>
Called by the build process in DacFx to give your code an opportunity to modify deployment configuration.
</summary>
<param name="setup">The current <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup"/> object.</param>
<exception cref="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException">If there is a critical error that should stop the build process
from continuing, implementing contributors may throw a <see cref="T:Microsoft.SqlServer.Dac.Deployment.BuildFailedException"/>.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.OnApplyDeploymentConfiguration(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext,System.Collections.Generic.ICollection{Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream})">
<summary>
Called by the deployment process in DacFx to give your code an opportunity to collect configuration information from the provided files.
At the end of the method all streams will be disposed.
Contributors that need to obtain data from the streams must read and cache the data during this method -
attempts to read from the stream during a later method such as the <see cref="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor.OnExecute(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext)"/> method
will fail.
</summary>
<param name="context">A <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext"/> object</param>
<param name="configurationStreams">An <see cref="T:System.Collections.Generic.ICollection`1"/> of <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream"/> objects</param>
<exception cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException">If there is a critical error that should stop the deployment process
from continuing, implementing contributors may throw a <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/>.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.Cancel">
<summary>
Cancels execution of the contributor
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.Canceled">
<summary>
Gets a value that indicates whether the contributor was canceled
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.CancellationToken">
<summary>
The <see cref="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor.CancellationToken"/> used to indicate whether contributor execution should be canceled
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor.OnExecute(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext)">
<summary>
Called by the deployment engine to allow custom contributors to execute their unique tasks
</summary>
<param name="context">A <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext"/> object</param>
<exception cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException">If there is a critical error the should stop the deployment process
from continuing, implementing contributors may throw a <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/>.</exception>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute">
<summary>
Concrete classes implementing <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanExecutor"/> must add the
<see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute"/> attribute to their class definition. This ensures
they will be detected and available for use during SQL Deployment.
<see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanExecutor"/>s require a unique ID which can be based on their fully qualified type name, or explicitly
passed as a string
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute.#ctor(System.String,System.String)">
<summary>
Initializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute"/>
</summary>
<param name="id">Unique Id used to identify the export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute.#ctor(System.Type,System.String)">
<summary>
Intializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanExecutorAttribute"/>
</summary>
<param name="implementingType">The Concrete type that extends <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanExecutor"/> - this is used
to generate the unique Id for this Export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup">
<summary>
Represents the current setup for <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor"/> objects.
The setup object can be used by deployment contributors during build operations to cause files
to be copied as outputs that are stored in the generated dacpac, or to create new files
that are stored in the dacpac. See the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream"/> API
for more information about specifying inputs.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup.EnumerateInputs">
<summary>
Returns an enumerable collection of <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream"/> objects.
</summary>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup.OpenNewOutput(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Returns a new output configuration file stream that is open for read and write.
</summary>
<param name="fileName">A partial file name.</param>
<param name="metadata">The metadata to be saved to the file.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup.CopyInputToOutput(Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream)">
<summary>
Copies an input stream's contents into an output stream that is stored inside a package
</summary>
<param name="stream"><see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream"/> to be copied</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup.Properties">
<summary>
Gets a dictionary that contains the current properties and settings.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationSetup.SqlCmdVariables">
<summary>
Gets the SqlCmd variables defined
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext">
<summary>
Provides a context for <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentContributor"/> objects in DacFx
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Arguments">
<summary>
Gets or sets a dictionary of named arguments and their values.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Options">
<summary>
Gets the options being used for this deployment
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.IsAzureSource">
<summary>
Does the <see cref="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Source"/> model a SQL Azure database.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.IsAzureTarget">
<summary>
Does the <see cref="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Target"/> model a SQL Azure database.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Source">
<summary>
Gets the Source <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext.Target">
<summary>
Gets the Target <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException">
<summary>
Represents an exception that occurs during deployment.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/> class
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/> class
</summary>
<param name="message">Indicates the reason for the exception.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/> class
</summary>
<param name="message">Indicates the reason for the exception.</param>
<param name="innerException">Indicates a nested exception.</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan">
<summary>
Represents the plan that is generated for Deployment.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.AddFirst(Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
</summary>
<param name="newStep"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.AddBefore(Microsoft.SqlServer.Dac.Deployment.DeploymentStep,Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
</summary>
<param name="step"></param>
<param name="newStep"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.AddAfter(Microsoft.SqlServer.Dac.Deployment.DeploymentStep,Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
</summary>
<param name="step"></param>
<param name="newStep"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.AddLast(Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
</summary>
<param name="newStep"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.AddLast(System.Collections.Generic.IEnumerable{Microsoft.SqlServer.Dac.Deployment.DeploymentStep})">
<summary>
</summary>
<param name="steps"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.Remove(Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
</summary>
<param name="step"></param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.StepCount">
<summary>
Total number of steps in the plan
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.Head">
<summary>
Gets the first deployment step
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlan.Tail">
<summary>
Gets the last deployment step
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle">
<summary>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle.Head">
<summary>
Returns the head on the plan or null if the plan is empty
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle.Tail">
<summary>
Returns the tail of the plan or null if the plan is empty
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext">
<summary>
Provides a context for <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor"/> objects.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext.ComparisonResult">
<summary>
Gets the <see cref="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext.PlanHandle">
<summary>
Gets the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext.DeploymentMasterPath">
<summary>
Set if a deployment script is also being generated against an Azure target
(which requires that the portion executed against master be its own script)
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributorContext.DeploymentScriptPath">
<summary>
Set if a deployment script is also being generated. This
enables other deployment contributors to correlate error messages back to a script/file
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier">
<summary>
Represents a constributor that can modify a deployment plan
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier.AddBefore(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle,Microsoft.SqlServer.Dac.Deployment.DeploymentStep,Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
Provides a way for subclasses to modify the plan by adding a
step after the specified step
</summary>
<param name="handle">The <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle"/> for the plan</param>
<param name="step">Identifies the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep"/> before which the <paramref name="newStep"/> will be added.</param>
<param name="newStep">The <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep"/> to be added</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier.AddAfter(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle,Microsoft.SqlServer.Dac.Deployment.DeploymentStep,Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
Provides a way to modify the existing plan by adding a step after the existing step
</summary>
<param name="handle">The <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle"/> for the plan</param>
<param name="step">Identifies the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep"/> after which the <paramref name="newStep"/> will be added.</param>
<param name="newStep">The <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep"/> to be added</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier.Remove(Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle,Microsoft.SqlServer.Dac.Deployment.DeploymentStep)">
<summary>
Provides a way to remove the specified step from the plan
</summary>
<param name="handle">The <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanHandle"/> for the plan</param>
<param name="step">Identifies the <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentStep"/> to be removed.</param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute">
<summary>
Concrete classes implementing <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier"/> must add the
<see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute"/> attribute to their class definition. This ensures
they will be detected and available for use during SQL Deployment.
<see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier"/>s require a unique ID which can be based on their fully qualified type name, or explicitly
passed as a string
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute.#ctor(System.String,System.String)">
<summary>
Initializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute"/>
</summary>
<param name="id">Unique Id used to identify the export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute.#ctor(System.Type,System.String)">
<summary>
Intializes a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ExportDeploymentPlanModifierAttribute"/>
</summary>
<param name="implementingType">The Concrete type that extends <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier"/> - this is used
to generate the unique Id for this <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier"/> Export </param>
<param name="version">Optional string defining the version number of the extension.
Must be a valid version string </param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1.CreateLoader">
<summary>
Creates a <see cref="T:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1"/> that uses standard extension lookup
properties and returns this to the caller
</summary>
<returns><see cref="T:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1"/></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1.#ctor(Microsoft.SqlServer.Dac.Extensibility.CompositionProperties)">
<summary>
Initializes the <see cref="T:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1"/>
</summary>
<param name="compositionProperties"><see cref="T:Microsoft.SqlServer.Dac.Extensibility.CompositionProperties"/> defining how contributors should be loaded</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1.GetMatchingExtensions(System.Collections.Generic.IEnumerable{Microsoft.Data.Tools.Schema.Sql.Deployment.ContributorInfo},System.Collections.Generic.List{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Gets all matching extensions for a set of required contributors.
</summary>
<param name="requiredContributors"><see cref="T:System.Collections.Generic.IEnumerable`1"/> specifying contributos to load and any version matching requirements</param>
<param name="typeLoadErrors">Output <see cref="T:System.Collections.Generic.List`1"/> containing all errors that occurred during load. This will include general load errors
for all contributors on the machine, plus load errors relating to version mismatch between requested contributor version
and the available contributors on the machine</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1.GetAllExtensions(System.Collections.Generic.List{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Gets all extensions matching the Contributor type.
</summary>
<param name="typeLoadErrors">Output <see cref="T:System.Collections.Generic.List`1"/> containing all errors that occurred during load. This will include general load errors
for all contributors on the machine, plus load errors relating to version mismatch between requested contributor version
and the available contributors on the machine</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.ContributorLoader`1.LoadSupportedContributorIds(System.Collections.Generic.IEnumerable{Microsoft.Data.Tools.Schema.Sql.Deployment.ContributorInfo},System.Collections.Generic.Dictionary{System.String,`0}@,System.Collections.Generic.List{Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError}@)">
<summary>
Finds and loads all contributors that match the expected <see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.ContributorInfo"/> data
</summary>
<param name="expectedContributors">Input enumerable of <see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.ContributorInfo"/>s defining the contributors being queried</param>
<param name="loadedContributors"><see cref="T:System.Collections.Generic.Dictionary`2"/> mapping contributor ID to an instance of the contributor</param>
<param name="loadErrors">Any <see cref="T:Microsoft.SqlServer.Dac.Extensibility.ExtensibilityError"/>s encountered while loading the contributors</param>
<returns>List of <see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.ContributorInfo"/>s describing the contributors that matched the query</returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinitionService">
<summary>
Service that provides data about a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinition"/>
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService">
<summary>
Service providing data required for a ModelComparisonResult
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.IsEqual">
<summary>
If compared elements are equal
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsEqual">
<summary>
List of elements that have no changes
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementGroupsEqual">
<summary>
List of element groups that are equal
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsToAdd">
<summary>
List of elements exists in source, does not exist in target
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsToDrop">
<summary>
List of elements exists in target, does not exist in source
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsChanged">
<summary>
List of elements are changed.
The result will keyed by elements in source, and it will have
what are the changes together with that changed element.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsPropertyChanged">
<summary>
List of elements changed because of properties are changed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsRelationshipEntryChanged">
<summary>
List of elements changed because of relationship entries are added or dropped
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsComposingChildrenChanged">
<summary>
List of elements changed because of composed children are changed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService.ElementsHierarchicalChildrenChanged">
<summary>
List of elements changed because of hierarchical dhildren are changed.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentContributorHelper`1">
<summary>
Helper class that converts and relays calls from Internal <see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.DeploymentContributor"/> API
to public external API
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentContributorHelper`1.ProcessContributorMethodCall(System.String,`0,System.Action{`0})">
<summary>
Calls a method on a contributor, handling message passing requirements.
Rethrows public <see cref="T:Microsoft.SqlServer.Dac.Deployment.DeploymentFailedException"/>s as internal
<see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.DeploymentFailedException"/>s.
</summary>
<param name="contributorId">Id of the contributor to be called </param>
<param name="contributor">contributor to be called</param>
<param name="contributorMethodCall">Action that </param>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentPlanContributorHelper`1">
<summary>
Helper class that converts and relays calls from Internal <see cref="T:Microsoft.Data.Tools.Schema.Sql.Deployment.DeploymentPlanContributor"/> API
to public external API
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentPlanExecutor">
<summary>
A shim between the public API and the internal DacFx API. Responsible for loading all public DeploymentPlanExecutor contributors, and
relaying the calls from the internal API to the public API
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentPlanModifier">
<summary>
A shim between the public API and the internal DacFx API. Responsible for loading all public DeploymentPlanModifier contributors, and
relaying the calls from the internal API to the public API
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentPlanRelay">
<summary>
Acts as a relay between the internal and public DeploymentPlans. Converts
Internal DeploymentStep objects to Public objects, and vice versa.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.Internal.InternalDeploymentPlanRelay.InternalStep">
<summary>
Wraps a step from the public API, ensuring it can be used by the internal API
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService">
<summary>
Service that provides data about a <see cref="T:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.AllowDropBlockingAssemblies">
<summary>
Get boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.AllowIncompatiblePlatform">
<summary>
Get boolean that specifies whether deployment will block due to platform compatibility.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.BackupDatabaseBeforeChanges">
<summary>
Get boolean that specifies whether a database backup will be performed before proceeding
with the actual deployment actions.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.BlockOnPossibleDataLoss">
<summary>
Get boolean that specifies whether deployment should stop if the operation could cause data loss.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.BlockWhenDriftDetected">
<summary>
Get boolean that specifies whether the system will check for differences between the
present state of the database and the registered state of the database and block deployment
if changes are detected. Even if this option is set to true, drift detection will only occur
on a database if it was previously deployed with the <see cref="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.RegisterDataTierApplication"/> option enabled.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.CommentOutSetVarDeclarations">
<summary>
Get boolean that specifies whether the declaration of SQLCMD variables are commented
out in the script header.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.CompareUsingTargetCollation">
<summary>
Get boolean that specifies whether the target collation will be used for identifier
comparison.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.CreateNewDatabase">
<summary>
Get boolean that specifies whether the existing database will be dropped
and a new database created before proceeding with the actual deployment actions.
Acquires single-user mode before dropping the existing database.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DeployDatabaseInSingleUserMode">
<summary>
Get boolean that specifies whether the system will acquire single-user mode on the target
database during the duration of the deployment operation.
</summary>
<remarks>
The database will be returned to multi-user mode after all changes are applied.
Database may remain in single-user mode if an error occurs during execution.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DisableAndReenableDdlTriggers">
<summary>
Get boolean that specifies if all DDL triggers will be disabled for the duration of the
deployment operation and then re-enabled after all changes are applied.
</summary>
<remarks>
Triggers may remain disabled if an error occurs during execution.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DoNotAlterChangeDataCaptureObjects">
<summary>
Get boolean that specifies whether items configured for Change Data Capture (CDC)
should be altered during deployment.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DoNotAlterReplicatedObjects">
<summary>
Get boolean that specifies whether items configured for Replication
should be altered during deployment.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropConstraintsNotInSource">
<summary>
Get boolean that specifies whether to drop all constraints that do not
exist in the source model.
</summary>
<remarks>
This applies to check, default, foreign key, primary key, and unique constraints.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropDmlTriggersNotInSource">
<summary>
Get boolean that specifies whether to drop all DML triggers that do not
exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropExtendedPropertiesNotInSource">
<summary>
Get boolean that specifies whether to drop all extended properties that do
not exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropIndexesNotInSource">
<summary>
Get boolean that specifies whether to drop all indexes that do not
exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropObjectsNotInSource">
<summary>
Get boolean that specifies whether objects that exist in the target but not source should be dropped during deployment.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropPermissionsNotInSource">
<summary>
Get boolean that specifies whether to drop all permissions that do not
exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropRoleMembersNotInSource">
<summary>
Get boolean that specifies whether to drop all role memberships that do not
exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.DropStatisticsNotInSource">
<summary>
Get boolean that specifies whether to drop all statistics that do not
exist in the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.GenerateSmartDefaults">
<summary>
Get boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values.
</summary>
<remarks>
This is useful when needing to add a new NOT NULL column to an existing table with data.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreAnsiNulls">
<summary>
Get boolean that specifies whether to exclude the ANSI_NULL option from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreAuthorizer">
<summary>
Get boolean that specifies whether to exclude the AUTHORIZATION option from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreColumnCollation">
<summary>
Get boolean that specifies whether to exclude the collation specifier from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreColumnOrder">
<summary>
Get boolean that specifies whether to exclude from consideration
the order of columns in tables when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreComments">
<summary>
Get boolean that specifies whether to exclude comments from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreCryptographicProviderFilePath">
<summary>
Get boolean that specifies whether to exclude the file specification
of a cryptographic provider from consideration when comparing the source and
target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreDdlTriggerOrder">
<summary>
Get boolean that specifies whether to exclude DDL trigger order from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreDdlTriggerState">
<summary>
Get boolean that specifies whether to exclude DDL trigger state from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreDefaultSchema">
<summary>
Get boolean that specifies whether to exclude the DEFAULT_SCHEMA option from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreDmlTriggerOrder">
<summary>
Get boolean that specifies whether to exclude DML trigger order from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreDmlTriggerState">
<summary>
Get boolean that specifies whether to exclude DML trigger state from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreExtendedProperties">
<summary>
Get boolean that specifies whether to exclude all extended properties from
consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreFileAndLogFilePath">
<summary>
Get boolean that specifies whether to exclude the FILENAME option of
FILE objects from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreFilegroupPlacement">
<summary>
Get boolean that specifies whether to exclude the filegroup specifier
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreFileSize">
<summary>
Get boolean that specifies whether to exclude the SIZE option of FILE objects
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreFillFactor">
<summary>
Get boolean that specifies whether to exclude the FILLFACTOR option
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreFullTextCatalogFilePath">
<summary>
Get boolean that specifies whether to exclude the path specification of
FULLTEXT CATALOG objects from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreIdentitySeed">
<summary>
Get boolean that specifies whether to exclude the seed value of IDENTITY columns
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreIncrement">
<summary>
Get boolean that specifies whether to exclude the increment value of IDENTITY columns
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreIndexOptions">
<summary>
Get boolean that specifies whether to exclude differences in index options
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreIndexPadding">
<summary>
Get boolean that specifies whether to exclude the PAD_INDEX option
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreKeywordCasing">
<summary>
Get boolean that specifies whether to exclude difference in the casing of keywords
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreLockHintsOnIndexes">
<summary>
Get boolean that specifies whether to exclude the ALLOW_ROW_LOCKS and
ALLOW_PAGE_LOGKS options from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreLoginSids">
<summary>
Get boolean that specifies whether to exclude the SID option of the LOGIN object
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreNotForReplication">
<summary>
Get boolean that specifies whether to exclude the NOT FOR REPLICATION option
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreObjectPlacementOnPartitionScheme">
<summary>
Get boolean that specifies whether to exclude the partition scheme object
from consideration when comparing the source and target model for the following
objects: Table, Index, Unique Key, Primary Key, and Queue.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnorePartitionSchemes">
<summary>
Get boolean that specifies whether to exclude the parameter type and
boundary VALUES of a PARTITION FUNCTION from consideration when comparing the
source and target model. Also excludes FILEGROUP and partition function of a
PARTITION SCHEMA from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnorePermissions">
<summary>
Get boolean that specifies whether to exclude all permission statements
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreQuotedIdentifiers">
<summary>
Get boolean that specifies whether to exclude the QUOTED_IDENTIFIER option
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreRoleMembership">
<summary>
Get boolean that specifies whether to exclude all ROLE MEMBERSHIP objects
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreRouteLifetime">
<summary>
Get boolean that specifies whether to exclude the LIFETIME option of ROUTE objects
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreSemicolonBetweenStatements">
<summary>
Get boolean that specifies whether to exclude the existence or absence of semi-colons
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreTableOptions">
<summary>
Get boolean that specifies whether the options on the target table are updated
to match the source table.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreUserSettingsObjects">
<summary>
Get boolean that specifies whether to exclude user settings
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreWhitespace">
<summary>
Get boolean that specifies whether to exclude whitespace
from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreWithNocheckOnCheckConstraints">
<summary>
Get boolean that specifies whether to exclude the CHECK|NO CHECK option of a CHECK
constraint object from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IgnoreWithNocheckOnForeignKeys">
<summary>
Get boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY
constraint object from consideration when comparing the source and target model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IncludeCompositeObjects">
<summary>
Get boolean that specifies whether to include referenced, external elements that also
compose the source model and then update the target database in a single deployment operation.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.IncludeTransactionalScripts">
<summary>
Get boolean that specifies whether to use transations during the deployment operation
and commit the transaction after all changes are successfully applied.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.NoAlterStatementsToChangeClrTypes">
<summary>
Get boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.PopulateFilesOnFileGroups">
<summary>
Get boolean that specifies whether files are supplied for filegroups defined in the deployment source.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.RegisterDataTierApplication">
<summary>
Get boolean that specifies whether the database will be registered as a Data-Tier Application.
If the target database is already a registered Data-Tier Application, then the registration will be updated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptDatabaseCollation">
<summary>
Get boolean that specifies whether the target database should be altered to match the
source model's collation.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptDatabaseCompatibility">
<summary>
Get boolean that specifies whether the target database should be altered to match the
source model's compatibility level.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptDatabaseOptions">
<summary>
Get boolean that specifies whether the database options in the target database should
be updated to match the source model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptDeployStateChecks">
<summary>
Get boolean that specifies whether the target database should be checked to ensure that
it exists, is online and can be updated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptFileSize">
<summary>
Get boolean that specifies whether a file size is specified when adding files to file groups.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptNewConstraintValidation">
<summary>
Get boolean that specifies whether constraints are validated after all changes are applied.
</summary>
<remarks>
Constraints are always added with NOCHECK option; as a result their validation is skipped during creation.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.ScriptRefreshModule">
<summary>
Get boolean that specifies whether referencing procedures are refreshed when referenced objects are updated.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.TargetConnectionString">
<summary>
Get string that specifies the target connection string
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.TargetDatabaseExists">
<summary>
Gets boolean that if set specifies whether the target database exists
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.TargetDatabaseName">
<summary>
Gets string that specifies the target database name
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.TargetingServerless">
<summary>
Get boolean that specifies whether the target server is LocalDB
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.TreatVerificationErrorsAsWarnings">
<summary>
Get boolean that specifies whether the deployment operation should proceed when errors are
generated during plan verification.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.UnmodifiableObjectWarnings">
<summary>
Get boolean that specifies whether the deployment operation should proceed when errors are
generated during plan verification.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.VerifyCollationCompatibility">
<summary>
Get boolean that specifies whether deployment will verify that the collation specified in the
source model is compatible with the collation specified in the target model.
</summary>
<value>
True to continue if errors are generated during plan verification; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.VerifyDeployment">
<summary>
Get boolean that specifies whether the plan verification phase is executed or not.
</summary>
<value>
True to perform plan verification; otherwise, false to skip it.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptionsService.SqlCommandVariableValues">
<summary>
Get dictionary of SQL command variable values, keyed by variable name.
</summary>
<value>
Dictionary of SQL command variable values, keyed by variable name.
</value>
<remarks>
Valid values must be provided for every variable before deployment, or failures may occur during deployment.
</remarks>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinition">
<summary>
Contains change details for a TSqlObject.
Including changed properties, added/dropped/ordinal changed relationship entries,
added/dropped/changed/ordinal changed composing children and
added/dropped/changed/ordinal changed hierarchical children.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinition.#ctor(Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinitionService)">
<summary>
Constructs a ModelComparisonChangeDefinition that uses a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinitionService"/>
to retrive definition data
</summary>
<param name="definitionService"></param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonChangeDefinition.TargetObject">
<summary>
Gets the target object of the change definition
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult">
<summary>
SchemaModel compare result.
Contains same elements list, elements needed to add to target list,
elements needed to drop in target list, and changed elements list.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.#ctor(Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService)">
<summary>
Constructs a ModelComparisonResult using a <see cref="T:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResultService"/>
to obtain the result data
</summary>
<param name="resultService"></param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.IsEqual">
<summary>
If compared elements are equal
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsEqual">
<summary>
List of elements that have no changes
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementGroupsEqual">
<summary>
List of element groups that are equal
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsToAdd">
<summary>
List of elements exists in source, does not exist in target
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsToDrop">
<summary>
List of elements exists in target, does not exist in source
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsChanged">
<summary>
List of elements are changed.
The result will keyed by elements in source, and it will have
what are the changes together with that changed element.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsPropertyChanged">
<summary>
List of elements changed because of properties are changed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsRelationshipEntryChanged">
<summary>
List of elements changed because of relationship entries are added or dropped
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsComposingChildrenChanged">
<summary>
List of elements changed because of composed children are changed.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.ModelComparisonResult.ElementsHierarchicalChildrenChanged">
<summary>
List of elements changed because of hierarchical dhildren are changed.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SchemaDeploymentResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SchemaDeploymentResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SchemaDeploymentResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SchemaDeploymentResources.DeployPlan_StepDoesNotHaveInternalMapping">
<summary>
Looks up a localized string similar to This step has no mapping in the internal deployment plan..
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions">
<summary>
Contains deployment options values used for deployment
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.AllowDropBlockingAssemblies">
<summary>
Get boolean that specifies whether CLR deployment will cause blocking assemblies to be dropped.
</summary>
<value>
True to drop blocking assemblies during CLR deployment; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.AllowIncompatiblePlatform">
<summary>
Get boolean that specifies whether deployment will block due to platform compatibility.
</summary>
<value>
True to block deployment to incompatible platforms; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.BackupDatabaseBeforeChanges">
<summary>
Get boolean that specifies whether a database backup will be performed before proceeding
with the actual deployment actions.
</summary>
<value>
True to perform a database backup prior to deployment; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.BlockOnPossibleDataLoss">
<summary>
Get boolean that specifies whether deployment should stop if the operation could cause data loss.
</summary>
<value>
True to stop deployment if possible data loss if detected; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.BlockWhenDriftDetected">
<summary>
Get boolean that specifies whether the system will check for differences between the
present state of the database and the registered state of the database and block deployment
if changes are detected. Even if this option is set to true, drift detection will only occur
on a database if it was previously deployed with the <see cref="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.RegisterDataTierApplication"/> option enabled.
</summary>
<value>
True to error is drift is detected; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.CommentOutSetVarDeclarations">
<summary>
Get boolean that specifies whether the declaration of SQLCMD variables are commented
out in the script header.
</summary>
<value>
True to comment out these declarations; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.CompareUsingTargetCollation">
<summary>
Get boolean that specifies whether the source collation will be used for identifier
comparison.
</summary>
<value>
False to use the source collation; otherwise, true to use the target collation.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.CreateNewDatabase">
<summary>
Get boolean that specifies whether the existing database will be dropped
and a new database created before proceeding with the actual deployment actions.
Acquires single-user mode before dropping the existing database.
</summary>
<value>
True to drop and re-create the database; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DeployDatabaseInSingleUserMode">
<summary>
Get boolean that specifies whether the system will acquire single-user mode on the target
database during the duration of the deployment operation.
</summary>
<value>
True to acquire single-user mode during deployment; otherwise, false.
Default is false.
</value>
<remarks>
The database will be returned to multi-user mode after all changes are applied.
Database may remain in single-user mode if an error occurs during execution.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DisableAndReenableDdlTriggers">
<summary>
Get boolean that specifies if all DDL triggers will be disabled for the duration of the
deployment operation and then re-enabled after all changes are applied.
</summary>
<value>
True to disable DDL triggers during deployment; otherwise, false.
Default is true.
</value>
<remarks>
Triggers may remain disabled if an error occurs during execution.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DoNotAlterChangeDataCaptureObjects">
<summary>
Get boolean that specifies whether items configured for Change Data Capture (CDC)
should be altered during deployment.
</summary>
<value>
True to not alter objects configured for CDC; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DoNotAlterReplicatedObjects">
<summary>
Get boolean that specifies whether items configured for Replication
should be altered during deployment.
</summary>
<value>
True to not alter objects configured for Replication; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropConstraintsNotInSource">
<summary>
Get boolean that specifies whether to drop all constraints that do not
exist in the source model.
</summary>
<value>
True to drop constraints not in the source model; otherwise, false.
Default is true.
</value>
<remarks>
This applies to check, default, foreign key, primary key, and unique constraints.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropDmlTriggersNotInSource">
<summary>
Get boolean that specifies whether to drop all DML triggers that do not
exist in the source model.
</summary>
<value>
True to drop DML triggers not in the source model; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropExtendedPropertiesNotInSource">
<summary>
Get boolean that specifies whether to drop all extended properties that do
not exist in the source model.
</summary>
<value>
True to drop extended properties not in the source model; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropIndexesNotInSource">
<summary>
Get boolean that specifies whether to drop all indexes that do not
exist in the source model.
</summary>
<value>
True to drop indexes not in the source model; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropObjectsNotInSource">
<summary>
Get boolean that specifies whether objects that exist in the target but not source should be dropped during deployment.
</summary>
<value>
True if objects that exist in the target but not source should be dropped; otherwise false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropPermissionsNotInSource">
<summary>
Get boolean that specifies whether to drop all permissions that do not
exist in the source model.
</summary>
<value>
True to drop permissions not in the source model; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropRoleMembersNotInSource">
<summary>
Get boolean that specifies whether to drop all role memberships that do not
exist in the source model.
</summary>
<value>
True to drop role memberships not in the source model; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.DropStatisticsNotInSource">
<summary>
Get boolean that specifies whether to drop all statistics that do not
exist in the source model.
</summary>
<value>
True to drop statistics not in the source model; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.GenerateSmartDefaults">
<summary>
Get boolean that specifies whether default values should be generated to populate NULL columns that are constrained to NOT NULL values.
</summary>
<value>
True if default values should be generated; otherwise false.
Default is false.
</value>
<remarks>
This is useful when needing to add a new NOT NULL column to an existing table with data.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreAnsiNulls">
<summary>
Get boolean that specifies whether to exclude the ANSI_NULL option from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the ANSI_NULL option; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreAuthorizer">
<summary>
Get boolean that specifies whether to exclude the AUTHORIZATION option from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the AUTHORIZATION option; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreColumnCollation">
<summary>
Get boolean that specifies whether to exclude the collation specifier from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the collation specifier; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreColumnOrder">
<summary>
Get boolean that specifies whether to exclude from consideration
the order of columns in tables when comparing the source and target model.
</summary>
<value>
True to ignore differences in column order; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreComments">
<summary>
Get boolean that specifies whether to exclude comments from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in comments; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreCryptographicProviderFilePath">
<summary>
Get boolean that specifies whether to exclude the file specification
of a cryptographic provider from consideration when comparing the source and
target model.
</summary>
<value>
True to ignore differences in a cryptographic provider's file specification; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreDdlTriggerOrder">
<summary>
Get boolean that specifies whether to exclude DDL trigger order from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in DDL trigger order; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreDdlTriggerState">
<summary>
Get boolean that specifies whether to exclude DDL trigger state from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in DDL trigger state; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreDefaultSchema">
<summary>
Get boolean that specifies whether to exclude the DEFAULT_SCHEMA option from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the DEFAULT_SCHEMA options; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreDmlTriggerOrder">
<summary>
Get boolean that specifies whether to exclude DML trigger order from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in DDL trigger order; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreDmlTriggerState">
<summary>
Get boolean that specifies whether to exclude DML trigger state from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in DML trigger state; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreExtendedProperties">
<summary>
Get boolean that specifies whether to exclude all extended properties from
consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in extended properties; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreFileAndLogFilePath">
<summary>
Get boolean that specifies whether to exclude the FILENAME option of
FILE objects from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the FILENAME option of FILE objects; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreFilegroupPlacement">
<summary>
Get boolean that specifies whether to exclude the filegroup specifier
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the filegroup specifier; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreFileSize">
<summary>
Get boolean that specifies whether to exclude the SIZE option of FILE objects
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the SIZE option of FILE objects; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreFillFactor">
<summary>
Get boolean that specifies whether to exclude the FILLFACTOR option
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the FILLFACTOR option; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreFullTextCatalogFilePath">
<summary>
Get boolean that specifies whether to exclude the path specification of
FULLTEXT CATALOG objects from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the path specification of FULLTEXT CATALOG objects; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreIdentitySeed">
<summary>
Get boolean that specifies whether to exclude the seed value of IDENTITY columns
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the seed value of IDENTITY columns; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreIncrement">
<summary>
Get boolean that specifies whether to exclude the increment value of IDENTITY columns
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the increment value of IDENTITY columns; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreIndexOptions">
<summary>
Get boolean that specifies whether to exclude differences in index options
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in index options; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreIndexPadding">
<summary>
Get boolean that specifies whether to exclude the PAD_INDEX option
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the PAD_INDEX option; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreKeywordCasing">
<summary>
Get boolean that specifies whether to exclude difference in the casing of keywords
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in the casing of keywords; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreLockHintsOnIndexes">
<summary>
Get boolean that specifies whether to exclude the ALLOW_ROW_LOCKS and
ALLOW_PAGE_LOGKS options from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the ALLOW_ROW_LOCKS and ALLOW_PAGE_LOGKS options; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreLoginSids">
<summary>
Get boolean that specifies whether to exclude the SID option of the LOGIN object
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the SID option of the LOGIN object; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreNotForReplication">
<summary>
Get boolean that specifies whether to exclude the NOT FOR REPLICATION option
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the NOT FOR REPLICATION option; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreObjectPlacementOnPartitionScheme">
<summary>
Get boolean that specifies whether to exclude the partition scheme object
from consideration when comparing the source and target model for the following
objects: Table, Index, Unique Key, Primary Key, and Queue.
</summary>
<value>
True to ignore partition schemes; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnorePartitionSchemes">
<summary>
Get boolean that specifies whether to exclude the parameter type and
boundary VALUES of a PARTITION FUNCTION from consideration when comparing the
source and target model. Also excludes FILEGROUP and partition function of a
PARTITION SCHEMA from consideration when comparing the source and target model.
</summary>
<value>
True to ignore aspects of partition functions and schemes; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnorePermissions">
<summary>
Get boolean that specifies whether to exclude all permission statements
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore all permission statements; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreQuotedIdentifiers">
<summary>
Get boolean that specifies whether to exclude the QUOTED_IDENTIFIER option
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the QUOTED_IDENTIFIER option; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreRoleMembership">
<summary>
Get boolean that specifies whether to exclude all ROLE MEMBERSHIP objects
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore ROLE MEMBERSHIP objects; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreRouteLifetime">
<summary>
Get boolean that specifies whether to exclude the LIFETIME option of ROUTE objects
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the LIFETIME option of ROUTE objects; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreSemicolonBetweenStatements">
<summary>
Get boolean that specifies whether to exclude the existence or absence of semi-colons
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore semi-colons; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreTableOptions">
<summary>
Get boolean that specifies whether the options on the target table are updated
to match the source table.
</summary>
<value>
True to ignore difference in table options and not update the target table; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreUserSettingsObjects">
<summary>
Get boolean that specifies whether to exclude user settings
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences in user settings; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreWhitespace">
<summary>
Get boolean that specifies whether to exclude whitespace
from consideration when comparing the source and target model.
</summary>
<value>
True to ignore differences whitespace; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreWithNocheckOnCheckConstraints">
<summary>
Get boolean that specifies whether to exclude the CHECK|NO CHECK option of a CHECK
constraint object from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the CHECK|NO CHECK option of a CHECK constraint object; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IgnoreWithNocheckOnForeignKeys">
<summary>
Get boolean that specifies whether to exclude the CHECK|NO CHECK option of a FOREIGN KEY
constraint object from consideration when comparing the source and target model.
</summary>
<value>
True to ignore the CHECK|NO CHECK option of a FOREIGN KEY constraint object; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IncludeCompositeObjects">
<summary>
Get boolean that specifies whether to include referenced, external elements that also
compose the source model and then update the target database in a single deployment operation.
</summary>
<value>
True to include composite objects; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.IncludeTransactionalScripts">
<summary>
Get boolean that specifies whether to use transations during the deployment operation
and commit the transaction after all changes are successfully applied.
</summary>
<value>
True to use transactions during deployment; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.NoAlterStatementsToChangeClrTypes">
<summary>
Get boolean that specifies whether to force a change to CLR assemblies by dropping and recreating them.
</summary>
<value>
True if CLR assemblies should be dropped; otherwise false to allow ALTER statements to change CLR assemblies.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.PopulateFilesOnFileGroups">
<summary>
Get boolean that specifies whether files are supplied for filegroups defined in the deployment source.
</summary>
<value>
True to specify files for filegroups; otherwise false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.RegisterDataTierApplication">
<summary>
Get boolean that specifies whether the database will be registered as a Data-Tier Application.
If the target database is already a registered Data-Tier Application, then the registration will be updated.
</summary>
<value>
True to register the database as a Data-Tier Application; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptDatabaseCollation">
<summary>
Get boolean that specifies whether the target database should be altered to match the
source model's collation.
</summary>
<value>
True to alter the target database's collation; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptDatabaseCompatibility">
<summary>
Get boolean that specifies whether the target database should be altered to match the
source model's compatibility level.
</summary>
<value>
True to alter the target database's compatibility level; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptDatabaseOptions">
<summary>
Get boolean that specifies whether the database options in the target database should
be updated to match the source model.
</summary>
<value>
True to alter the target database's options; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptDeployStateChecks">
<summary>
Get boolean that specifies whether the target database should be checked to ensure that
it exists, is online and can be updated.
</summary>
<value>
True to perform state checks on the target database; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptFileSize">
<summary>
Get boolean that specifies whether a file size is specified when adding files to file groups.
</summary>
<value>
True to specify a file size when adding files to file groups; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptNewConstraintValidation">
<summary>
Get boolean that specifies whether constraints are validated after all changes are applied.
</summary>
<value>
True to validate check constraints; otherwise, false.
Default is true.
</value>
<remarks>
Constraints are always added with NOCHECK option; as a result their validation is skipped during creation.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.ScriptRefreshModule">
<summary>
Get boolean that specifies whether referencing procedures are refreshed when referenced objects are updated.
</summary>
<value>
True to refresh referencing procedures; otherwise false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.TargetConnectionString">
<summary>
Get string that specifies the target connection string
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.TargetDatabaseExists">
<summary>
Gets boolean that if set specifies whether the target database exists
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.TargetDatabaseName">
<summary>
Gets string that specifies the target database name
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.TargetingServerless">
<summary>
Get boolean that specifies whether the target server is LocalDB
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.TreatVerificationErrorsAsWarnings">
<summary>
Get boolean that specifies whether to treat errors that occur during publish verification as warnings.
The check is performed against the generated deployment plan before the plan is executed against the target database.
Plan verification detects problems, such as the loss of target-only objects (for example, indexes), that must be
dropped to make a change. Verification also detects situations where dependencies (such as tables or views) exist
because of a reference to a composite project, but do not exist in the target database. You might choose to treat
verification errors as warnings to get a complete list of issues instead of allowing the publish
action to stop when the first error occurs.
</summary>
<value>
True to treat errors as warnings; otherwise, false.
Default is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.UnmodifiableObjectWarnings">
<summary>
Get boolean that specifies whether warnings should be generated when differences are found
in objects that cannot be modified, for example, if the file size or file paths were different for a file.
</summary>
<value>
True to generate warnings; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.VerifyCollationCompatibility">
<summary>
Get boolean that specifies whether deployment will verify that the collation specified in the
source model is compatible with the collation specified in the target model.
</summary>
<value>
True to continue if errors are generated during plan verification; otherwise, false.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.VerifyDeployment">
<summary>
Get boolean that specifies whether the plan verification phase is executed or not.
</summary>
<value>
True to perform plan verification; otherwise, false to skip it.
Default is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Deployment.SqlDeploymentOptions.SqlCommandVariableValues">
<summary>
Get dictionary of SQL command variable values, keyed by variable name.
</summary>
<value>
Dictionary of SQL command variable values, keyed by variable name.
</value>
<remarks>
Valid values must be provided for every variable before deployment, or failures may occur during deployment.
</remarks>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes">
<summary>
Defines the type of objects to query from the model.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.None">
<summary>
Filter out all elements.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.UserDefined">
<summary>
Query user defined objects.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.BuiltIn">
<summary>
Query built in system objects
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.SameDatabase">
<summary>
Query user defined objects from referenced models where the referenced model is for the same database.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.System">
<summary>
Query System objects that are not treated as built in. These are objects that appear when the master
database is referenced
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.DifferentDatabaseSameServer">
<summary>
Query references to external objects that are from a different database on the same server.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.DifferentDatabaseDifferentServer">
<summary>
Query references to external objects that are from a different database on a different same server.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.Default">
<summary>
Default query scope is to query both <see cref="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.UserDefined"/>
and <see cref="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.BuiltIn"/> query scopes
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes.All">
<summary>
All elements in the model, including references to external elements.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacModelError">
<summary>
Represents a model blocking error.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.ErrorType">
<summary>
Type of model blocking error
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.ErrorCode">
<summary>
DacModelError error code
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.Line">
<summary>
Line Number of the error
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.Column">
<summary>
Column Number of the error
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.Prefix">
<summary>
DacModelError prefix
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.Message">
<summary>
Message from DacModelError
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.SourceName">
<summary>
The TSqlObject with error.
Can be null if the object creation failed completely.
Could be a partially constructed object in case of partial failures in object creation.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.SourceType">
<summary>
Type of the TSqlObject associated with the error
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelError.Severity">
<summary>
Severity of the error
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DisplayServices">
<summary>
Provides a set of services for providing user-visible values for objects in the public model API.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DisplayServices.GetEscapedNameString(System.String)">
<summary>
Pass in a short name string, return back an escaped version of the name string.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DisplayServices.GetElementName(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.Model.ElementNameStyle)">
<summary>
Get element name string using different display style.
</summary>
<param name="element"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> </param>
<param name="style"></param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.DisplayServices.GetDisplayName(Microsoft.SqlServer.Dac.Model.ObjectIdentifier,Microsoft.SqlServer.Dac.Model.EscapeStyle,System.Boolean)">
<summary>
Get display name of an identifier, with the option to configure use of full/short name and whether to escape name parts.
</summary>
<param name="identifier">The name identifier that can contain multiple parts.</param>
<param name="escapeStyle"><see cref="T:Microsoft.SqlServer.Dac.Model.EscapeStyle"/> defining whether the parts of the name should be escaped or not</param>
<param name="fullName">Indicates if the name is constructed in full or only the significant last part is used.</param>
<returns>Display name</returns>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ElementNameStyle">
<summary>
Defines the different naming styles supported by the display services
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementNameStyle.Unknown">
<summary>
Unknown or undefined style - should be avoided
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementNameStyle.SimpleName">
<summary>
A non-escaped short name style.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementNameStyle.EscapedSimpleName">
<summary>
An escaped short name style.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementNameStyle.FullyQualifiedName">
<summary>
A non-escaped fully qualified name style.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementNameStyle.EscapedFullyQualifiedName">
<summary>
An escaped fully qualified name style.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.EscapeStyle">
<summary>
Enum to specify escape style for displaying model name
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.EscapeStyle.Escape">
<summary>
Names should be escaped
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.EscapeStyle.DontEscape">
<summary>
Names should not be escaped
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.EscapeStyle.EscapeIfNecessary">
<summary>
Names should be escaped if not doing so would cause errors
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1">
<summary>
Base class for elements with commented out script body
Parses the given script with all known prior platform parsers until the script is successfully parsed.
On successful parssing, extracts the TSqlStatment specified by the type parameter T
</summary>
<typeparam name="T">The create sql statement</typeparam>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.GetParsedFragment">
<summary>
Parse the script with all known prior parsers
</summary>
<returns>Successfully parsed TSqlFragment parsed. null if not able to parse</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.ExtractSingleTSqlStatement">
<summary>
Extract the single TSQLStatment contained within the successfully parsed script.
</summary>
<returns>Single TSQLStatment within the successfully parsed script.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.GetTSqlScriptWithCommentedScriptBody">
<summary>
Implemented by inherited members to comment out the script body of the Statement
</summary>
<returns>TSqlScipt of the element with commented out script body</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.SqlPlatform">
<summary>
The SqlPlatform parser to first employ when trying to parse the script
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.ParsedFragment">
<summary>
Contains the successfully parsed TSqlFragment parsed by some prior platform parser.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementWithCommentedScriptBody`1.Statement">
<summary>
The single TSQLStatment contained within the script that was successfully parsed by some prior platform parser.
Unpon construction, null value for Statement denotes either script was not successfully parsed or there were more than one statements.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelAnnotationPropertyContext">
<summary>
Property context for properties that are converted from annotations in the internal model.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ExternalDefinitionMetadataContext">
<summary>
<see cref="T:Microsoft.SqlServer.Dac.Model.ModelMetadataContext"/> implementation that handles external definition actions. These
define a mapping from an internal <see cref="T:Microsoft.Data.Tools.Schema.SchemaModel.ModelElementClass"/> to a value in a public Enum type.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ElementDescriptor">
<summary>
Describes a SQL model element without instantiating a <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> in the
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ElementDescriptor.GetModelElement(Microsoft.SqlServer.Dac.Model.TSqlModel)">
<summary>
Gets the corresponding <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> that matches this descriptor from a model.
If no object matches the descriptor then null will be returned
</summary>
<param name="model"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/> the object should be found in</param>
<returns>
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> that this <see cref="T:Microsoft.SqlServer.Dac.Model.ElementDescriptor"/> maps to, or null
if no object definitively matches this descriptor
</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.IsEmpty">
<summary>
Returns if descriptor is empty (doesn't contain any identifiers). It is possible for
a descriptor to have a generated name - i.e. based on the context of a statement
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.HasUsableName">
<summary>
Helper to signify whether this descriptor has a name that is usable - i.e. the
name parts represent the name of a SQL object.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.IgnoreName">
<summary>
Gets if name should be ignored for this descriptor. It is possible for a
descriptor to have no name AND IgnoreName == false
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.TypeClass">
<summary>
Returns back the type class that maps to the ElementType.
If there is no public mapping for the internal type then null will be returned.
If the internal type maps to more than one element class the first element class
is returned.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.Identifiers">
<summary>
The parts of the elements name.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ElementDescriptor.ExternalReferenceParts">
<summary>
Returns external parts for elements name
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance">
<summary>
Specifies how a fragment being visited is related to a descriptor
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance.None">
<summary>
No relevance or unknown relevance
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance.ContainerId">
<summary>
The descriptor is related to an object that contains the fragment
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ElementDescriptorRelevance.SelfId">
<summary>
The descriptor represents the same concept as the fragment
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.CreateProcedureStatementWithCommentedScriptBody">
<summary>
Represents substituting a CreateProcedureStatement with commented out script body
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.CreateViewStatementWithCommentedScriptBody">
<summary>
Represents substituting a CreateViewStatement with commented out script body
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelCollationComparer">
<summary>
Comparer that can compare strings and <see cref="T:Microsoft.SqlServer.Dac.Model.ObjectIdentifier"/>s using the collation of a <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>.
This can be very useful when comparing objects in the model since comparisons will be consistent with the expected comparison
results in SQL Server
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(System.String,System.String)">
<summary>
Compare if two objects are equal.
</summary>
<param name="x">Source object.</param>
<param name="y">Target object.</param>
<returns>True if equal, otherwise false.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String})">
<summary>
Test if two identifiers are equal using collation of this comparer.
</summary>
<param name="x">List of name parts in the first identifier.</param>
<param name="y">List of name parts in the second identifier.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(Microsoft.SqlServer.Dac.Model.ObjectIdentifier,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Test if two identifiers are equal using collation of this comparer.
</summary>
<param name="x">The first <see cref="T:Microsoft.SqlServer.Dac.Model.ObjectIdentifier"/>.</param>
<param name="y">The second <see cref="T:Microsoft.SqlServer.Dac.Model.ObjectIdentifier"/>.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.GetHashCode(Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Gets a Hashcode for the object that's compatible with the
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(Microsoft.SqlServer.Dac.Model.ObjectIdentifier,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)"/> method of this comparer
</summary>
<param name="obj">The object to get a hashcode for</param>
<returns>hashcode</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.GetHashCode(System.Collections.Generic.IList{System.String})">
<summary>
Gets a Hashcode for the object that's compatible with the
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String})"/> method of this comparer
</summary>
<param name="obj">The object to get a hashcode for</param>
<returns>hashcode</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.GetHashCode(System.String)">
<summary>
Gets a Hashcode for the object that's compatible with the
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Equals(System.String,System.String)"/> method of this comparer
</summary>
<param name="obj">The object to get a hashcode for</param>
<returns>hashcode</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Compare(System.String,System.String)">
<summary>
Compare two objects using collation of this comparer.
</summary>
<param name="x">Source object.</param>
<param name="y">Target object.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Compare(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String})">
<summary>
Compare two objects using collation of this comparer.
</summary>
<param name="x">Source object.</param>
<param name="y">Target object.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelCollationComparer.Compare(Microsoft.SqlServer.Dac.Model.ObjectIdentifier,Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Compare two objects using collation of this comparer.
</summary>
<param name="x">Source object.</param>
<param name="y">Target object.</param>
<returns></returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.InternalModelUtils.IsInlineConstraintOrIndex(Microsoft.Data.Tools.Schema.SchemaModel.IModelElement)">
<summary>
Checks if an internal element represents an inline constraint or annotation
</summary>
<param name="element">The element to check</param>
<returns>True if the element is an inline constraint or index. False otherwise.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.InternalModelUtils.TryGetSingleReferencedElementInfo(Microsoft.Data.Tools.Schema.SchemaModel.ModelRelationshipClass,Microsoft.Data.Tools.Schema.SchemaModel.IModelElement,Microsoft.Data.Tools.Schema.SchemaModel.IModelElement@,Microsoft.Data.Tools.Schema.SchemaModel.ModelIdentifier@)">
<summary>
Tries to get info from a relationship on an element. The relationship must have single cardinality.
If successful the information returned will at a minimum be the <see cref="T:Microsoft.Data.Tools.Schema.SchemaModel.ModelIdentifier"/>
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor">
<summary>
This class represents an ambigous element descriptor, where it's not fully clear which
element in the model a descriptor might map to
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.PotentialElementDescriptor.Relevance">
<summary>
Gets the Relevance associated with the potential descriptor
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SchemaAnalysisService">
<summary>
Internal service that links the public <see cref="T:Microsoft.SqlServer.Dac.Model.SchemaAnalyzer"/> code to the internal
analyzer codebase
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SchemaAnalysisService.CreateAnalysisService(Microsoft.SqlServer.Dac.Model.SchemaAnalyzer)">
<summary>
Factory method to construct a service. May want to move this into the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObjectService"/>
if we ever wanted to abstract away implementation details even further
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SimpleModelRelationshipContext">
<summary>
Default Property context for all properties.
</summary>
<remarks>
Provides default implementation for relationship access through the public model.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.SimpleModelRelationshipContext.CollapsedRelationshipClasses">
<summary>
The possible relationships for the collapsed reference lookup
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacModelMessage">
<summary>
Represents an error or a warning raised during model validation.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacModelResources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.AddObjectsErrorAddingObjects">
<summary>
Looks up a localized string similar to Add or update objects failed due to the following errors: .
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.AddObjectsModelErrorsExist">
<summary>
Looks up a localized string similar to Cannot add or update objects. The model has build blocking errors:.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.AstNotRetrieved">
<summary>
Looks up a localized string similar to The AST could not be retrieved for the specified object..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.AstNotSupportedError">
<summary>
Looks up a localized string similar to AST retrieval not supported for the specified object..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.AutoGeneratedCommentedScriptBodyText">
<summary>
Looks up a localized string similar to \nAuto generated text: The original script body has been commented in order to add this object to the model.\n.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ConvertObject_SourceNameDifferentFromObjectSource">
<summary>
Looks up a localized string similar to Cannot convert object to script. The source name '{0}' does not match existing source name '{1}'. Changing source names is not supported..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ConvertObject_SourceNameExists">
<summary>
Looks up a localized string similar to Cannot convert object to script. The source name '{0}' is already in use in this model.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ConvertObject_WhitespaceNotAllowed">
<summary>
Looks up a localized string similar to Source name cannot consist of whitespace.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.DacpacLoadReferenceError">
<summary>
Looks up a localized string similar to Cannot load package '{0}'. Required references are missing..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.DeleteObjectsErrorDeletingObjects">
<summary>
Looks up a localized string similar to Delete objects failed due to the following errors: .
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.DeleteObjectsModelErrorsExist">
<summary>
Looks up a localized string similar to Cannot delete objects from the model. The model has build blocking errors:.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ErrorScriptNameValidation">
<summary>
Looks up a localized string similar to {0}: parameter {1} cannot be null, the empty string, all whitespace, or end in ".xsd".
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.GetObjectsTopLevelTypesRequiredError">
<summary>
Looks up a localized string similar to Type '{0}' is not a top-level type. Only top-level types can be queried for using the TSqlModel GetObject(s) methods..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InconsistentPropertyTypes">
<summary>
Looks up a localized string similar to Not all property types match expected type '{0}'..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InternalPropertyMappingInvalid">
<summary>
Looks up a localized string similar to Internal Error. No internal property mapped on internal type {0} for public property {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InternalPropertyTypeMismatchErrorMessage">
<summary>
Looks up a localized string similar to Internal Error. Data types for internal properties '{0}.{1}' and '{2}.{3}' do not match..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InternalRelationshipMappingInvalid">
<summary>
Looks up a localized string similar to No internal relationship mapped on internal type {0} for public relationship {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InternalTypeMappingInvalid">
<summary>
Looks up a localized string similar to Internal Error. No public type mapping was found for internal type {0}, for element with id {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidContextObjectErrorMessage">
<summary>
Looks up a localized string similar to Internal Error. Context object must implement ISqlModelElement..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidContextObjectForDefaultErrorMessage">
<summary>
Looks up a localized string similar to Internal Error. There is no context object to derive a default from..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidMetadataContextErrorMessage">
<summary>
Looks up a localized string similar to Metadata {0} has an invalid context type..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidMetadataTypeErrorMessage">
<summary>
Looks up a localized string similar to Data type {1} for metadata {0} cannot be cast to {2}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidModelElementErrorMessage">
<summary>
Looks up a localized string similar to Internal Error. Internal elements must implement IModelElement..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidNavigationPathRelationship">
<summary>
Looks up a localized string similar to Relationship '{0}.{1}' cannot be used for type collapsing navigation as it is a one-to-many relationship..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidPropertyContextErrorMessage">
<summary>
Looks up a localized string similar to Property {0} has an invalid context type..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidPropertyTypeErrorMessage">
<summary>
Looks up a localized string similar to Data type {1} for property {0} cannot be cast to {2}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidRelationshipContextErrorMessage">
<summary>
Looks up a localized string similar to Relationship {0} has an invalid context type..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidTypeErrorMessage">
<summary>
Looks up a localized string similar to Data type {0} cannot be cast to {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.InvalidTypeNameErrorMessage">
<summary>
Looks up a localized string similar to The type name {0} is not valid..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.LoadScriptBackedModelFailed">
<summary>
Looks up a localized string similar to Loading source as a script-backed model failed due to the following errors:.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MetadataDoesNotMapEnumErrorMessage">
<summary>
Looks up a localized string similar to Internal error. Type '{0}' is not an Enum, expected Enum for GetMetadata.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MetadataNotSupportedOnTypeErrorMessage">
<summary>
Looks up a localized string similar to ModelMetadataClass {0} is not supported on type {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MissingMetadataMappingErrorMessage">
<summary>
Looks up a localized string similar to Metadata context must be mapped to at least one internal property..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MissingPropertyMappingErrorMessage">
<summary>
Looks up a localized string similar to Internal Error. Property context must be mapped to at least one internal property..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MissingReference">
<summary>
Looks up a localized string similar to No file was supplied for reference {0}; model load might fail. When {1} was created, the original referenced file was located {2}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MissingReference_NoPackagePath">
<summary>
Looks up a localized string similar to No file was supplied for reference {0}; model load might fail. When package was created, the original referenced file was located {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MissingRelationshipMappingErrorMessage">
<summary>
Looks up a localized string similar to Context must include at least one internal relationship mapping.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ModelDisposedError">
<summary>
Looks up a localized string similar to The underlying model has been disposed..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ModelErrorsExist">
<summary>
Looks up a localized string similar to The model has build blocking errors:.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.MoreThanOneObjectMatchedId">
<summary>
Looks up a localized string similar to More than one object matched the ID '{0}'..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.NoValidEnumForMetadata">
<summary>
Looks up a localized string similar to Type '{0}' does not have a mapping for the int value '{1}'.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.PropertiesNotSupportedForRelationshipError">
<summary>
Looks up a localized string similar to Properties are not supported on ModelRelationshipInstances for Relationship {0}.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.PropertyNotSupportedOnRelationshipErrorMessage">
<summary>
Looks up a localized string similar to ModelPropertyClass {0} is not supported on relationship {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.PropertyNotSupportedOnTypeErrorMessage">
<summary>
Looks up a localized string similar to ModelPropertyClass {0} is not supported on type {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.PublicContributorThrewExceptionMessage">
<summary>
Looks up a localized string similar to DeploymentContributor '{0}' threw exception. Message is: '{1}'.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.RelationshipNotSupportedOnTypeErrorMessage">
<summary>
Looks up a localized string similar to ModelRelationshipClass {0} is not supported on type {1}..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.SaveModelErrorsExist">
<summary>
Looks up a localized string similar to Cannot save package to file. The model has build blocking errors:.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ScriptNotRetrieved">
<summary>
Looks up a localized string similar to The script could not be retrieved for the specified object..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ScriptNotSupportedError">
<summary>
Looks up a localized string similar to Script retrieval not supported for the specified object..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.ServiceDisposedError">
<summary>
Looks up a localized string similar to The underlying model service has been disposed..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.UpdateModelErr">
<summary>
Looks up a localized string similar to Error updating model..
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.UpdateModelErr_PackageContainsData">
<summary>
Looks up a localized string similar to Cannot update the model as the package contains data. This is not supported since it could cause errors during deployment.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.DacModelResources.UpdateModelErr_UnsupportedDacpacVersion">
<summary>
Looks up a localized string similar to Updating package with version '{0}' is not supported. Only packages with version 3.0 or higher are supported for update..
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.DacQueryScopes">
<summary>
Defines the type of objects to query from the model.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.None">
<summary>
Filter out all elements.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined">
<summary>
Query user defined objects.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.BuiltIn">
<summary>
Query built in system objects
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.SameDatabase">
<summary>
Query user defined objects from referenced models where the referenced model is for the same database.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.System">
<summary>
Query System objects that are not treated as built in. These are objects that appear when the master
database is referenced
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.Default">
<summary>
Default query scope is to query both <see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined"/>
and <see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.BuiltIn"/> query scopes
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.All">
<summary>
All elements in the model, not including references to external elements in non-system databases.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlElementDescriptor.Equals(System.Object)">
<summary>
<see cref="M:System.Object.Equals(System.Object)"/>
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlElementDescriptor.GetHashCode">
<summary>
<see cref="M:System.Object.GetHashCode"/>
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SqlModelCollationComparer">
<summary>
Internal SQL implementation of the <see cref="T:Microsoft.SqlServer.Dac.Model.ModelCollationComparer"/>. Uses the
comparer built into an internal model for the comparison
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SqlSchemaModelLoader">
<summary>
Responsible for loading a model from a dacpac
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SqlSchemaModelLoader.ModelHeaderDataLoader">
<summary>
Loads references, SqlCmd variables, and refactor log data from a dacpac
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.TSqlObjectService.ConvertToScriptedModel(System.Threading.CancellationToken)">
<summary>
Converts objects in a given scope into scriptable objects by deleting the internal representation of
user defined objects and recreating them with a script-backed representation
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.TSqlObjectService.ConvertToScriptedObject(Microsoft.SqlServer.Dac.Model.TSqlObject,System.String)">
<summary>
Converts a specific top-level object in the model into a scripted representation of itself. This is done
by scripting out the element, then dropping this element, and finally adding it back in and resolving the model
</summary>
<returns>New copy of the TSqlObject, which will now be script-backed</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">If the object could not be scripted out, this class of object is never scriptable,
or errors were found in the model during the script process </exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.#ctor(Microsoft.SqlServer.Dac.Model.TSqlModelSchema,Microsoft.Data.Tools.Schema.SchemaModel.DataSchemaModel)">
<summary>
Internal for testing purposes only. Use SqlSchemaModelObjectService(InternalModel.DataSchemaModel model)for
product code.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.#ctor(Microsoft.Data.Tools.Schema.SchemaModel.DataSchemaModel)">
<summary>
Public constructor to be used by product code
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.CreateParserRepository">
<summary>
Initialize TSqlParserRepository
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.SetScriptBacked(System.Boolean)">
<summary>
Internal method that enables setting whether the model is script-backed or not. This can be used to
warn about code analysis running against a non-scripted model, for instance.
</summary>
<param name="isScriptBacked"></param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.TryGetObject(Microsoft.Data.Tools.Schema.SchemaModel.IModelElement,Microsoft.SqlServer.Dac.Model.TSqlObject@)">
<summary>
Internal utility method - wraps an internal model element in a public TSqlObject. Should never be exposed as part of the service.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetObjects(System.String,Microsoft.SqlServer.Dac.Model.ModelTypeClass[])">
<summary>
Retrieves all TSqlObjects in a given source document filtered by ModelTypeClass specified by the types parameter
</summary>
<param name="sourceName">Name of the source document</param>
<param name="types">Array of ModelTypeClass that the resulting TSqlObject should be filtered on.
If the parameter is a empty list, all objects will be returned.</param>
<returns>List of TSqlObjects</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetModelErrors">
<summary>
Retrieves all model errors.
</summary>
<returns>List of model errors</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetModelIdForNamedObjectId(Microsoft.SqlServer.Dac.Model.ObjectIdentifier)">
<summary>
Gets the internal that matches a public ID
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetAsValidIModelElement(System.Object)">
<summary>
Converts an object to an IModelElement, throwing if the cast is invalid
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.IsToplevelObject(Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Returns if an object's create script is a top level T-SQL statement.
</summary>
<param name="tSqlObject"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> to query.</param>
<returns>True if object's create statement is a top level statement.</returns>
<exception cref="T:System.ArgumentNullException">If <paramref name="tSqlObject"/> is null.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.TryGetAst(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.TransactSql.ScriptDom.TSqlScript@)">
<summary>
Generates the AST for the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/>.
</summary>
<returns>True is AST generated.</returns>
<param name="ast">Generated AST.</param>
<param name="tSqlObject"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> to query.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="tSqlObject"/> is null.</exception>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">Thrown if the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlObject.ContextObject"/> property of <paramref name="tSqlObject"/> does not implement correct type.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.TryGetScript(Microsoft.SqlServer.Dac.Model.TSqlObject,System.String@)">
<summary>
Generates the script for the <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/>.
</summary>
<returns>True is script generated.</returns>
<param name="tSqlObject">The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> to be scripted</param>
<param name="script">Generated script.</param>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="tSqlObject"/> is null.</exception>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">Thrown if the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlObject.ContextObject"/> property of <paramref name="tSqlObject"/> does not implement correct type.</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.CreateCacheIdentifier(System.String)">
<summary>
Creates an identifier that is compatible with the internal model's treatment of source names.
Internally the ScriptCache checks for "MSSQLL::" at the beginning of a source name.
This indicates that the name isn't a path and shouldn't be auto-expanded based on the current working directory.
We don't want to treat source names passed into the public API as paths, especially since this would result in
the current working directory being added in front of any source name that wasn't a fully qualified path.
The tradeoff is external users of the API don't get the benefit of us auto-resolving relative paths for them,
but that's an acceptable tradeoff
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetSourceNameFromCacheId(System.String)">
<summary>
Removes the "MSSQL::" string from the beginning of a cache identifier to get the source name.
see <see cref="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.CreateCacheIdentifier(System.String)"/> for more information on why this behavior is needed
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ExecutePackageOperationWithErrorHandling(System.Action)">
<summary>
Performs error handling around an operation on a DacPackage, such as creating or updating
the package. There are a standard set of exceptions that can be thrown in this case
</summary>
<exception cref="T:Microsoft.SqlServer.Dac.DacServicesException">Thrown if any error occurs when operating on the package</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.GetSourceInformationInternal(Microsoft.Data.Tools.Schema.SchemaModel.ISourceInformation)">
<summary>
Gets source info from an internal source by stripping any cache ID info from the source name
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ConvertToScriptedObject(Microsoft.SqlServer.Dac.Model.TSqlObject,System.String)">
<summary>
Converts a specific top-level object in the model into a scripted representation of itself. This is done
by scripting out the element, then dropping this element, and finally adding it back in and resolving the model
</summary>
<returns>New copy of the TSqlObject, which will now be script-backed</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">If the object could not be scripted out, this class of object is never scriptable,
or errors were found in the model during the script process </exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ConvertToScriptedObject(Microsoft.SqlServer.Dac.Model.TSqlObject,System.String,System.String)">
<summary>
For simplicity, keeping this method private for now. Consider exposing publicly as a perf improvement in scenarios where
caller clearly knows that they want to directly replace an unscripted model element (e.g. a table) with a new definition.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ConvertToScriptedModel(System.Threading.CancellationToken)">
<summary>
Converts all user-defined objects in the model into scripted representations of themselves. This is done
by scripting out the elements we're going to drop, then dropping all these elements, and finally adding them
back in and resolving the model
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.CollectObjectsToBeRecreated(System.Collections.Generic.Dictionary{System.String,System.Tuple{Microsoft.SqlServer.Dac.Model.TSqlObject,System.String}},System.Threading.CancellationToken)">
<summary>
One step in converting objects to a scripted model: Must create script representations of each object to be deleted,
since we would like to remove them all and re-add them with only one Resolve operation. Otherwise we would have to
resolve after each delete and recreation to avoid unresolved references causing problems during scripting
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.DropAndRecreateElements(System.Collections.Generic.Dictionary{System.String,System.Tuple{Microsoft.SqlServer.Dac.Model.TSqlObject,System.String}},System.Threading.CancellationToken)">
<summary>
One step in converting objects to a scripted model:
for each of the objects to be dropped and recreated the element, its composed children and inline hierarchical
children are all deleted. Then they are added back into the model via the scripted representation of the objects.
Note that this does not call Resolve on the model in order to support multiple updates followed by a single
resolve, hence the caller must ensure the model is resolved once all these operations are completed.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.DoAddOrUpdateSubstitutedObject(Microsoft.Data.Tools.Schema.Sql.SchemaModel.ISqlModelElement,System.String,Microsoft.SqlServer.Dac.Model.TSqlObjectOptions,System.String,System.String)">
<summary>
If adding an object to the model fails due to model blocking errors and if the ModelLoadOption is set to not throw on errors,
the original object is substituted with a replacement object whose errant parts are removed. These errors are common in case of objects with
old deprecated syntax.
This method substitutes stored procedures and views with equivalent new objects that has commented out script body.
In case of other types of objects, an empty element with just the name of the errant object is added to the model.
</summary>
<param name="element">The element that originally failed to add to the model.</param>
<param name="sourceName">source name of the object</param>
<param name="options">TSqlObjectOptions for the object</param>
<param name="script">Script of the object</param>
<param name="cacheIdentifier">cache identifier for the object</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ModelBuilder">
<summary>
Internal for testing purposes only
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.DataSchemaModel">
<summary>
Internal, only to be accessed by internal services as required.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeAll">
<summary>
If query scope includes all elements, even externals
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeAllNonExternal">
<summary>
If query scope includes all elements, except
non-Composite external
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeUserDefined">
<summary>
If query scope includes user defined elements
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeBuiltIn">
<summary>
if query scope includes built-in elements
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeSameDatabase">
<summary>
If query scope includes external elements in the same database
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeSystem">
<summary>
If query scope includes elements from system dacpac ("master" reference)
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeDifferentDatabaseSameServer">
<summary>
If query scope includes external elements in a different database on this server (for return of ID only)
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter._includeDifferentDatabaseDifferentServer">
<summary>
If query scope includes external elements in a different database on a separate server (for return of ID only)
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter.SetupScopeVariables(Microsoft.SqlServer.Dac.Model.DacQueryScopes)">
<summary>
Converts <see cref="T:Microsoft.SqlServer.Dac.Model.DacQueryScopes"/> into filter criteria to use when querying the internal model.
</summary>
<param name="queryScopes">QueryScope to expand.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter.SetupScopeVariables(Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes)">
<summary>
Converts <see cref="T:Microsoft.SqlServer.Dac.Model.DacExternalQueryScopes"/> into filter criteria to use when querying the internal model.
</summary>
<param name="queryScopes">QueryScope to expand.</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter.ShouldReturnElement(Microsoft.Data.Tools.Schema.SchemaModel.IModelElement)">
<summary>
Determines if the element matches the query criteria. Fully external elements
should never be returned from this method, though system elements may be supported.
</summary>
<param name="element">Element to consider</param>
<returns>true if element matches query criteria. Otherwise false.</returns>
/// <remarks></remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter.ShouldReturnIdForElement(Microsoft.Data.Tools.Schema.SchemaModel.IModelElement)">
<summary>
Determines if the element ID can be returned - external elements will support
return of the external ID in a relationship instance, but should never support
return of the actual element.
</summary>
<param name="element">Element to consider</param>
<returns>true if element matches query criteria. Otherwise false.</returns>
/// <remarks></remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.SqlSchemaModelObjectService.ScopeFilter.QueryFilter">
<summary>
filter used when retrieving element
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelErrorSeverity">
<summary>
Represents the severity level of the model error
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorSeverity.Unknown">
<summary>
Severity is unknown
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorSeverity.Error">
<summary>
Model error
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorSeverity.Warning">
<summary>
Warning in the model
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelErrorType">
<summary>
The model error type. Represents the various classification of model blocking errors.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorType.ParserError">
<summary>
Represents a parser error in an object in the model
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorType.InterpreterError">
<summary>
Represents a interpreter error in an object in the model
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelErrorType.ModelValidationError">
<summary>
Any other model blocking validation errors.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelExtractOptions">
<summary>
Defines options that affect the behavior of loading a model from a database.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.#ctor">
<summary>
Construct a new instance of the <see cref="T:Microsoft.SqlServer.Dac.Model.ModelExtractOptions"/> class.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.ExtractReferencedServerScopedElements">
<summary>
Get or set boolean that specifies whether server-scoped elements referenced by the source should be extracted.
</summary>
<value>
True if references server-scoped elements should be extracted; otherwise false.
Default value is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.ExtractApplicationScopedObjectsOnly">
<summary>
Get or set boolean that specifies the scope of objects extracted from the source.
</summary>
<value>
True if only application-scoped objects should be extracted;
otherwise false to extract all object types.
Default value is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.IgnoreExtendedProperties">
<summary>
Get or set boolean that specifies whether extended properties should be ignored.
</summary>
<value>
True if extended properties will be ignored; otherwise false.
Default value is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.IgnorePermissions">
<summary>
Get or set boolean that specifies whether permissions should be ignored.
</summary>
<value>
True if permissions will be ignored; otherwise false.
Default value is true.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.IgnoreUserLoginMappings">
<summary>
Get or set boolean that specifies whether mappings between users and logins should be extracted from the source.
</summary>
<value>
True if user login mappings will be ignored; otherwise false.
Default value is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.Storage">
<summary>
Get the type of backing storage for the schema model used during extraction.
</summary>
<value>
Enumeration value that specifies the type of backing storage for the schema model used during extraction.
Default value is File.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.VerifyExtraction">
<summary>
Get or set boolean that specifies whether the extracted package should be verified.
</summary>
<value>
True if the package should be verified; otherwise false.
Default value is false.
</value>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.LoadAsScriptBackedModel">
<summary>
Should the model be loaded so that objects are backed up by scripted representations? In this case objects in the
<see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined"/> scope will have a source name and source position information.
When loading from a Dacpac or any other non-scripted source the model will not have source information. This
means that when running static code analysis using the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> some rules may not work
correctly, and that existing objects in the model could not be replaced using the
<see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.AddOrUpdateObjects(System.String,System.String,Microsoft.SqlServer.Dac.Model.TSqlObjectOptions)"/> method since there
is no script with their original definition. For scenarios that use the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> setting this
to true is strongly recommended. Similarly if you wish to update existing objects in the model setting this to true may
be useful.
Note that there is a potentially significant performance cost involved in creating a scripted model. All
top level objects in the <see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined"/> scope will be scripted out as strings
and then replaced with their scripted representations, after which the model will then have to fully resolve all
relationships. This will cause a one-time performance hit at the time the model is loaded.
</summary>
<remarks>Default value is false, since there is a performance hit involved in creating a script-backed model from a
non-scripted source</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelExtractOptions.ExtractUsageProperties">
<summary>
Usage properties include Table.RowCount, Table.IndexSize, Table.DataSize, Table.UsedPages and Table.DataPages.
When true, these properties are extracted from the database and are accessible in the model.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelLoadOptions">
<summary>
Options for loading a model from a data source such as a Dacpac file.
These options can be very important depending on the scenario. For instance
when running static code analysis using the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> it is strongly recommended that
the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.LoadAsScriptBackedModel"/> option be set to true, as many rules expect a fully scripted source and
may not operate as expected on a non script-backed model.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.#ctor">
<summary>
Constructs an instance of <see cref="T:Microsoft.SqlServer.Dac.Model.ModelLoadOptions"/> with the default options, which are
to use <see cref="F:Microsoft.SqlServer.Dac.DacSchemaModelStorageType.Memory"/> storage and to set
<see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.LoadAsScriptBackedModel"/> to be false.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.#ctor(Microsoft.SqlServer.Dac.DacSchemaModelStorageType,System.Boolean)">
<summary>
Constructs an instance of <see cref="T:Microsoft.SqlServer.Dac.Model.ModelLoadOptions"/> with the specified options.
</summary>
<param name="modelStorageType">Value for the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.ModelStorageType"/> property</param>
<param name="loadAsScriptBackedModel">Value for the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.LoadAsScriptBackedModel"/> property</param>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.#ctor(Microsoft.SqlServer.Dac.DacSchemaModelStorageType,System.Boolean,System.Boolean)">
<summary>
Constructs an instance of <see cref="T:Microsoft.SqlServer.Dac.Model.ModelLoadOptions"/> with the specified options.
</summary>
<param name="modelStorageType">Value for the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.ModelStorageType"/> property</param>
<param name="loadAsScriptBackedModel">Value for the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.LoadAsScriptBackedModel"/> property</param>
<param name="throwOnModelErrors">Value for the <see cref="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.ThrowOnModelErrors"/> property</param>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.ModelStorageType">
<summary>
Should the model be stored in memory or should a file-backed storage be used?
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.LoadAsScriptBackedModel">
<summary>
Should the model be loaded so that objects are backed up by scripted representations? In this case objects in the
<see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined"/> scope will have a source name and source position information.
When loading from a Dacpac or any other non-scripted source the model will not have source information. This
means that when running static code analysis using the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> some rules may not work
correctly, and that existing objects in the model could not be replaced using the
<see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.AddOrUpdateObjects(System.String,System.String,Microsoft.SqlServer.Dac.Model.TSqlObjectOptions)"/> method since there
is no script with their original definition. For scenarios that use the <see cref="T:Microsoft.SqlServer.Dac.CodeAnalysis.CodeAnalysisService"/> setting this
to true is strongly recommended. Similarly if you wish to update existing objects in the model setting this to true may
be useful.
Note that there is a potentially significant performance cost involved in creating a scripted model. All
top level objects in the <see cref="F:Microsoft.SqlServer.Dac.Model.DacQueryScopes.UserDefined"/> scope will be scripted out as strings
and then replaced with their scripted representations, after which the model will then have to fully resolve all
relationships. This will cause a one-time performance hit at the time the model is loaded.
</summary>
<remarks>Default value is false, since there is a performance hit involved in creating a script-backed model from a
non-scripted source</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelLoadOptions.ThrowOnModelErrors">
<summary>
Defines whether the model edit APIs throw a <see cref="T:Microsoft.SqlServer.Dac.Model.DacModelException"/> if there are any blocking errors present in the model.
When adding a new object or deleting/modifying existing objects in the model using API calls such as
<see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.AddObjects(System.String)"/>, <see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.AddOrUpdateObjects(System.String,System.String,Microsoft.SqlServer.Dac.Model.TSqlObjectOptions)"/>, <see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.DeleteObjects(System.String)"/>
and <see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.ConvertToScriptedObject(Microsoft.SqlServer.Dac.Model.TSqlObject,System.String)"/>, the model throws <see cref="T:Microsoft.SqlServer.Dac.Model.DacModelException"/> signaling
the presence of model blocking errors. Model blocking errors indicates the presence of serious errors such as parser, interpreter and other errors in the objects.
Setting this option to false allows building the model even if it has such serious errors. Subsequently those objects with model errors can be retrieved using the
<see cref="M:Microsoft.SqlServer.Dac.Model.TSqlModel.GetModelErrors"/> method.
When objects with model blocking errors are added to the model, the object is edited such that errant parts are removed or commented out in a
best effort manner to preserve the parts of the object that do not have errors. For instance a stored procedure that has a parser error in the procedure body
will have its body commented out before adding to the model. As a worst case the object is completely dropped while preserving the model errors.
Note that current implementation handles objects with model errors as follows
1) Sql procedures and views are added to the model with commented body.
2) Other object types are completely dropped while preserving the model errors.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelMetadataClass">
<summary>
The metadata class for metadata properties.
</summary>
<remarks>
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModelSchema"/> metadata classes provide access to the structure and instance data
within a <c>TSqlSchemaModel</c> instance.
</remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelMetadataClass.GetValue``1(Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Returns the metadata property value.
</summary>
<typeparam name="T"><see cref="T:System.Type"/> of the metadata property value.</typeparam>
<param name="instance"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> instance to get the metadata property value from.</param>
<returns>Metadata property value.</returns>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelMetadataClass.Name">
<summary>
Metadata property name.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelMetadataClass.DataType">
<summary>
Data type of the metadata property.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelMetadataClass.OwningType">
<summary>
Owning <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/> for the <see cref="T:Microsoft.SqlServer.Dac.Model.ModelMetadataClass"/>.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelPropertyClass">
<summary>
The metadata class for properties.
</summary>
<remarks>
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModelSchema"/> metadata classes provide access to the structure and instance data
within a <c>TSqlSchemaModel</c> instance.
</remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetValue``1(Microsoft.SqlServer.Dac.Model.TSqlObject)">
<summary>
Returns the property value.
</summary>
<typeparam name="T"><see cref="T:System.Type"/> of the property value.</typeparam>
<param name="instance"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> instance to get the property value from.</param>
<returns>Property value.</returns>
<exception cref="T:System.InvalidCastException">
If the property value cannot be cast to <typeparamref name="T"/>.
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue``1(Microsoft.SqlServer.Dac.Model.SqlServerVersion)">
<summary>
Returns the default property value.
Note: for <see cref="F:Microsoft.SqlServer.Dac.Model.SqlServerVersion.SqlAzure"/> the default value may depend on the
<see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> being targeted. This method assumes the current default
version is being used. To get a default value based on a particular for a particular EngineVersion, please use
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue``1(Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)"/>.
</summary>
<typeparam name="T"><see cref="T:System.Type"/> of the property value.</typeparam>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to return the default value for.</param>
<returns>Default value for specified <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>.</returns>
<exception cref="T:System.InvalidCastException">
If the property value cannot be cast to <typeparamref name="T"/>.
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue(Microsoft.SqlServer.Dac.Model.SqlServerVersion)">
<summary>
Returns the default property value.
Note: for <see cref="F:Microsoft.SqlServer.Dac.Model.SqlServerVersion.SqlAzure"/> the default value may depend on the
<see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> being targeted. This method assumes the current default
version is being used. To get a default value based on a particular for a particular EngineVersion, please use
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue(Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)"/>.
</summary>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to return the default value for.</param>
<returns>Default value for specified <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.IsDefaultValue(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.Model.SqlServerVersion)">
<summary>
Returns if the value is the platform default value.
Note: for <see cref="F:Microsoft.SqlServer.Dac.Model.SqlServerVersion.SqlAzure"/> the default value may depend on the
<see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> being targeted. This method assumes the current default
version is being used. To validate the default value based on a particular for a particular EngineVersion, please use
<see cref="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.IsDefaultValue(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)"/>.
</summary>
<param name="instance"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> instance to determine the default property value for.</param>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to determine the default value for.</param>
<returns>True if the property is the platform default. Otherwise false.</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">
If the supplied <paramref name="instance"/> is not the owner of this property.
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue``1(Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)">
<summary>
Returns the default property value.
Note: for <see cref="F:Microsoft.SqlServer.Dac.Model.SqlServerVersion.SqlAzure"/> the default value may depend on the
<see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> being targeted.
</summary>
<typeparam name="T"><see cref="T:System.Type"/> of the property value.</typeparam>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to return the default value for.</param>
<param name="engineVersion">
Optional value for the engine version. This maps to the
<see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> property on a model.
</param>
<returns>Default value for specified <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>.</returns>
<exception cref="T:System.InvalidCastException">
If the property value cannot be cast to <typeparamref name="T"/>.
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.GetDefaultValue(Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)">
<summary>
Returns the default property value.
</summary>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to return the default value for.</param>
<param name="engineVersion">
Optional value for the engine version. This maps to the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> property on a model.
</param>
<returns>Default value for specified <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/>.</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.IsDefaultValue(Microsoft.SqlServer.Dac.Model.TSqlObject,Microsoft.SqlServer.Dac.Model.SqlServerVersion,System.Int32)">
<summary>
Returns if the value is the platform default value.
</summary>
<param name="instance"><see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> instance to determine the default property value for.</param>
<param name="version">The <see cref="T:Microsoft.SqlServer.Dac.Model.SqlServerVersion"/> to determine the default value for.</param>
<param name="engineVersion">
Optional value for the engine version. This maps to the <see cref="P:Microsoft.SqlServer.Dac.Model.TSqlModel.EngineVersion"/> property on a model.
</param>
<returns>True if the property is the platform default. Otherwise false.</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">
If the supplied <paramref name="instance"/> is not the owner of this property.
</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.Name">
<summary>
Property name.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.DataType">
<summary>
Data type of the property.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.SupportedPlatforms">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlPlatforms"/> versions on which this relationship is supported.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.OwningType">
<summary>
Owning <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/> for the property, where this
property is attached to a Type. Null if this property is on a
<see cref="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass"/>
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelPropertyClass.OwningRelationship">
<summary>
Owning <see cref="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass"/> for the property, where this
property is attached to a Relationship. Null if this property is on a
<see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/>
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass">
<summary>
The metadata class for relationships.
</summary>
<remarks>
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModelSchema"/> metadata classes provide access to the structure and instance data
within a <c>TSqlSchemaModel</c> instance.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass.Name">
<summary>
Relationship name.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass.Type">
<summary>
Type of the relationship.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass.FromObjectClass">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/> of the referencing object for the relationship.
This represents the class of objects the relationship comes from
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass.SupportedPlatforms">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlPlatforms"/> versions on which this relationship is supported.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass.Properties">
<summary>
Properties for the relationship.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance">
<summary>
Represents a reference from one <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> to another, which might be unresolved.
</summary>
<remarks>
<see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModelSchema"/> metadata classes provide access to the structure and instance data
within a <c>TSqlModelSchema</c> instance.
</remarks>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.GetProperty``1(Microsoft.SqlServer.Dac.Model.ModelPropertyClass)">
<summary>
Retrieves properties for this relationship instance.
</summary>
<typeparam name="T"><see cref="T:System.Type"/> of the property value.</typeparam>
<param name="property"><see cref="T:Microsoft.SqlServer.Dac.Model.ModelPropertyClass"/> property to retrieve.</param>
<returns>Property value.</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">
If the supplied <paramref name="property"/> is not supported on this instance.
</exception>
<exception cref="T:System.InvalidCastException">
If the property type cannot be cast to T.
</exception>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.GetProperty(Microsoft.SqlServer.Dac.Model.ModelPropertyClass)">
<summary>
Retrieves properties for this relationship instance.
</summary>
<param name="property"><see cref="T:Microsoft.SqlServer.Dac.Model.ModelPropertyClass"/> property to retrieve.</param>
<returns>Property value.</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">
If the supplied <paramref name="property"/> is not supported on this instance.
</exception>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.Relationship">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipClass"/> this instance represents.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.FromObject">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> this instance is from. This is the referencing object
</summary>
<remarks>
This property returns null if the relationship is unresolved or refers to elements outside the current <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.Object">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlObject"/> this instance references. This is the referenced object.
</summary>
<remarks>
This property returns null if the relationship is unresolved or refers to elements outside the current <see cref="T:Microsoft.SqlServer.Dac.Model.TSqlModel"/>.
</remarks>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.ObjectName">
<summary>
The <see cref="T:Microsoft.SqlServer.Dac.Model.ObjectIdentifier"/> representing the name of the referenced object.
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.PropertyContext">
<summary>
The context boject to use for property lookup - if this isn't set then <see cref="M:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.GetProperty``1(Microsoft.SqlServer.Dac.Model.ModelPropertyClass)"/>
is not supported on this <see cref="T:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance"/>. For internal use only
</summary>
</member>
<member name="P:Microsoft.SqlServer.Dac.Model.ModelRelationshipInstance.Item(Microsoft.SqlServer.Dac.Model.ModelPropertyClass)">
<summary>
Retrieves properties for this relationship instance.
</summary>
<param name="property"><see cref="T:Microsoft.SqlServer.Dac.Model.ModelPropertyClass"/> property to retrieve.</param>
<returns>Property value.</returns>
<exception cref="T:Microsoft.SqlServer.Dac.Model.DacModelException">
If the supplied <paramref name="property"/> is not supported on this instance.
</exception>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ModelSchema">
<summary>
Model schema for TSqlModel
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelSchema.InitializeModelSchema">
<summary>
The ModelSchema has static state that is extremely useful when navigating a model's
contents. Under normal circumstances (use of ) the static state is indirectly initialized and clients
can use the state oblivious to how it has been initialized. In other heads (commandline / API / unit tests) it is possible
for the static state to be uninitialized prior to it's being used causing unexpected nulls and failures. When implementing
a new head that may directly use the ModelSchema prior to instantiating a TSqlModel call this method prior to
accessing any static state.
</summary>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelSchema.GetViewSubroutineAndTriggerClasses">
<summary>
Gets the set of classes representing Views, Subroutines and Triggers. This is a common set of classes used during
analysis
</summary>
<returns>The <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/>es representing view, subroutines and triggers</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelSchema.GetSubroutineClasses">
<summary>
Gets the set of classes representing Subroutines. This is a common set of classes used during
analysis
</summary>
<returns>The <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/>es representing subroutines</returns>
</member>
<member name="M:Microsoft.SqlServer.Dac.Model.ModelSchema.GetColumnSourceClasses">
<summary>
Gets the set of classes representing a potential source of columns. Tables, Views, Functions can all be
a source for this
</summary>
<returns>The <see cref="T:Microsoft.SqlServer.Dac.Model.ModelTypeClass"/>es representing view, subroutines and triggers</returns>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SchemaInstance">
<summary>
Instance of the model schema
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Column">
<summary>
Model type class for Column
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableValuedFunction">
<summary>
Model type class for TableValuedFunction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ScalarFunction">
<summary>
Model type class for ScalarFunction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ClrTableOption">
<summary>
Model type class for ClrTableOption
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Aggregate">
<summary>
Model type class for Aggregate
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ApplicationRole">
<summary>
Model type class for ApplicationRole
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Index">
<summary>
Model type class for Index
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Assembly">
<summary>
Model type class for Assembly
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.AssemblySource">
<summary>
Model type class for AssemblySource
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.AsymmetricKey">
<summary>
Model type class for AsymmetricKey
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.AuditAction">
<summary>
Model type class for AuditAction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.AuditActionGroup">
<summary>
Model type class for AuditActionGroup
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.AuditActionSpecification">
<summary>
Model type class for AuditActionSpecification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.BrokerPriority">
<summary>
Model type class for BrokerPriority
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.BuiltInServerRole">
<summary>
Model type class for BuiltInServerRole
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DataType">
<summary>
Model type class for DataType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Certificate">
<summary>
Model type class for Certificate
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.CheckConstraint">
<summary>
Model type class for CheckConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ClrTypeMethod">
<summary>
Model type class for ClrTypeMethod
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ClrTypeMethodParameter">
<summary>
Model type class for ClrTypeMethodParameter
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ClrTypeProperty">
<summary>
Model type class for ClrTypeProperty
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ColumnStoreIndex">
<summary>
Model type class for ColumnStoreIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Contract">
<summary>
Model type class for Contract
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Credential">
<summary>
Model type class for Credential
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseCredential">
<summary>
Model type class for DatabaseCredential
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.CryptographicProvider">
<summary>
Model type class for CryptographicProvider
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseAuditSpecification">
<summary>
Model type class for DatabaseAuditSpecification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseDdlTrigger">
<summary>
Model type class for DatabaseDdlTrigger
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseEncryptionKey">
<summary>
Model type class for DatabaseEncryptionKey
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseEventNotification">
<summary>
Model type class for DatabaseEventNotification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseMirroringLanguageSpecifier">
<summary>
Model type class for DatabaseMirroringLanguageSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseOptions">
<summary>
Model type class for DatabaseOptions
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DataCompressionOption">
<summary>
Model type class for DataCompressionOption
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Default">
<summary>
Model type class for Default
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DefaultConstraint">
<summary>
Model type class for DefaultConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DmlTrigger">
<summary>
Model type class for DmlTrigger
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Endpoint">
<summary>
Model type class for Endpoint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ErrorMessage">
<summary>
Model type class for ErrorMessage
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventGroup">
<summary>
Model type class for EventGroup
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventSession">
<summary>
Model type class for EventSession
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.DatabaseEventSession">
<summary>
Model type class for DatabaseEventSession
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventSessionAction">
<summary>
Model type class for EventSessionAction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventSessionDefinitions">
<summary>
Model type class for EventSessionDefinitions
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventSessionSetting">
<summary>
Model type class for EventSessionSetting
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventSessionTarget">
<summary>
Model type class for EventSessionTarget
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.EventTypeSpecifier">
<summary>
Model type class for EventTypeSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ExtendedProcedure">
<summary>
Model type class for ExtendedProcedure
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ExtendedProperty">
<summary>
Model type class for ExtendedProperty
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ExternalDataSource">
<summary>
Model type class for ExternalDataSource
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ExternalFileFormat">
<summary>
Model type class for ExternalFileFormat
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ExternalTable">
<summary>
Model type class for ExternalTable
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SqlFile">
<summary>
Model type class for SqlFile
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Filegroup">
<summary>
Model type class for Filegroup
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ForeignKeyConstraint">
<summary>
Model type class for ForeignKeyConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.FullTextCatalog">
<summary>
Model type class for FullTextCatalog
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.FullTextIndex">
<summary>
Model type class for FullTextIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.FullTextIndexColumnSpecifier">
<summary>
Model type class for FullTextIndexColumnSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.FullTextStopList">
<summary>
Model type class for FullTextStopList
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.HttpProtocolSpecifier">
<summary>
Model type class for HttpProtocolSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.LinkedServer">
<summary>
Model type class for LinkedServer
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.LinkedServerLogin">
<summary>
Model type class for LinkedServerLogin
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Login">
<summary>
Model type class for Login
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.MasterKey">
<summary>
Model type class for MasterKey
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.MessageType">
<summary>
Model type class for MessageType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PartitionFunction">
<summary>
Model type class for PartitionFunction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PartitionScheme">
<summary>
Model type class for PartitionScheme
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PartitionValue">
<summary>
Model type class for PartitionValue
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Permission">
<summary>
Model type class for Permission
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PrimaryKeyConstraint">
<summary>
Model type class for PrimaryKeyConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Procedure">
<summary>
Model type class for Procedure
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Queue">
<summary>
Model type class for Queue
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.QueueEventNotification">
<summary>
Model type class for QueueEventNotification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.RemoteServiceBinding">
<summary>
Model type class for RemoteServiceBinding
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ResourceGovernor">
<summary>
Model type class for ResourceGovernor
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ResourcePool">
<summary>
Model type class for ResourcePool
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Role">
<summary>
Model type class for Role
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.RoleMembership">
<summary>
Model type class for RoleMembership
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Route">
<summary>
Model type class for Route
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Rule">
<summary>
Model type class for Rule
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Schema">
<summary>
Model type class for Schema
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SearchProperty">
<summary>
Model type class for SearchProperty
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SearchPropertyList">
<summary>
Model type class for SearchPropertyList
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SecurityPolicy">
<summary>
Model type class for SecurityPolicy
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SecurityPredicate">
<summary>
Model type class for SecurityPredicate
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Sequence">
<summary>
Model type class for Sequence
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerAudit">
<summary>
Model type class for ServerAudit
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerAuditSpecification">
<summary>
Model type class for ServerAuditSpecification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerDdlTrigger">
<summary>
Model type class for ServerDdlTrigger
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerEventNotification">
<summary>
Model type class for ServerEventNotification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerOptions">
<summary>
Model type class for ServerOptions
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServerRoleMembership">
<summary>
Model type class for ServerRoleMembership
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Service">
<summary>
Model type class for Service
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.ServiceBrokerLanguageSpecifier">
<summary>
Model type class for ServiceBrokerLanguageSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Signature">
<summary>
Model type class for Signature
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SignatureEncryptionMechanism">
<summary>
Model type class for SignatureEncryptionMechanism
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SoapLanguageSpecifier">
<summary>
Model type class for SoapLanguageSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SoapMethodSpecification">
<summary>
Model type class for SoapMethodSpecification
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SpatialIndex">
<summary>
Model type class for SpatialIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Statistics">
<summary>
Model type class for Statistics
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Parameter">
<summary>
Model type class for Parameter
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SymmetricKey">
<summary>
Model type class for SymmetricKey
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SymmetricKeyPassword">
<summary>
Model type class for SymmetricKeyPassword
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Synonym">
<summary>
Model type class for Synonym
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.Table">
<summary>
Model type class for Table
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.FileTable">
<summary>
Model type class for FileTable
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableType">
<summary>
Model type class for TableType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypeCheckConstraint">
<summary>
Model type class for TableTypeCheckConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypeColumn">
<summary>
Model type class for TableTypeColumn
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypeDefaultConstraint">
<summary>
Model type class for TableTypeDefaultConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypeIndex">
<summary>
Model type class for TableTypeIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypePrimaryKeyConstraint">
<summary>
Model type class for TableTypePrimaryKeyConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TableTypeUniqueConstraint">
<summary>
Model type class for TableTypeUniqueConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.TcpProtocolSpecifier">
<summary>
Model type class for TcpProtocolSpecifier
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.UniqueConstraint">
<summary>
Model type class for UniqueConstraint
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.User">
<summary>
Model type class for User
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.UserDefinedServerRole">
<summary>
Model type class for UserDefinedServerRole
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.UserDefinedType">
<summary>
Model type class for UserDefinedType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.View">
<summary>
Model type class for View
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.WorkloadGroup">
<summary>
Model type class for WorkloadGroup
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.XmlIndex">
<summary>
Model type class for XmlIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.SelectiveXmlIndex">
<summary>
Model type class for SelectiveXmlIndex
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.XmlNamespace">
<summary>
Model type class for XmlNamespace
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PromotedNodePathForXQueryType">
<summary>
Model type class for PromotedNodePathForXQueryType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.PromotedNodePathForSqlType">
<summary>
Model type class for PromotedNodePathForSqlType
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ModelSchema.XmlSchemaCollection">
<summary>
Model type class for XmlSchemaCollection
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.ColumnType">
<summary>
Specifies the type of Column a TSqlObject represents
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ColumnType.Column">
<summary>
Column
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ColumnType.ComputedColumn">
<summary>
ComputedColumn
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.ColumnType.ColumnSet">
<summary>
ColumnSet
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.TableTypeColumnType">
<summary>
Specifies the type of TableTypeColumn a TSqlObject represents
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.TableTypeColumnType.Column">
<summary>
Column
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.TableTypeColumnType.ComputedColumn">
<summary>
ComputedColumn
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.FunctionType">
<summary>
Specifies the type of Function a TSqlObject represents
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.FunctionType.InlineTableValuedFunction">
<summary>
InlineTableValuedFunction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.FunctionType.MultiStatementTableValuedFunction">
<summary>
MultiStatementTableValuedFunction
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.SqlDataType">
<summary>
SQL Server built-in data types
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Unknown">
<summary>
Nothing was defined.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.BigInt">
<summary>
Integer (whole number) data from -2^63 (-9,223,372,036,854,775,808) through 2^63-1 (9,223,372,036,854,775,807).
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Int">
<summary>
Integer (whole number) data from -2^31 (-2,147,483,648) through 2^31 - 1 (2,147,483,647).
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.SmallInt">
<summary>
Integer data from -2^15 (-32,768) through 2^15 - 1 (32,767).
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.TinyInt">
<summary>
Integer data from 0 through 255.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Bit">
<summary>
Integer data with either a 1 or 0 value.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Decimal">
<summary>
Fixed precision and scale numeric data from -10^38 +1 through 10^38 -1.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Numeric">
<summary>
Functionally equivalent to decimal.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Money">
<summary>
Monetary data values from -2^63 (-922,337,203,685,477.5808) through 2^63 - 1 (+922,337,203,685,477.5807), with accuracy to a ten-thousandth of a monetary unit.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.SmallMoney">
<summary>
Monetary data values from -214,748.3648 through +214,748.3647, with accuracy to a ten-thousandth of a monetary unit.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Float">
<summary>
Floating precision number data with the following valid values: -1.79E + 308 through -2.23E - 308, 0 and 2.23E + 308 through 1.79E + 308.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Real">
<summary>
Floating precision number data with the following valid values: -3.40E + 38 through -1.18E - 38, 0 and 1.18E - 38 through 3.40E + 38.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.DateTime">
<summary>
Date and time data from January 1, 1753, through December 31, 9999, with an accuracy of three-hundredths of a second, or 3.33 milliseconds.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.SmallDateTime">
<summary>
Date and time data from January 1, 1900, through June 6, 2079, with an accuracy of one minute.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Char">
<summary>
Fixed-length non-Unicode character data with a maximum length of 8,000 characters.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.VarChar">
<summary>
Variable-length non-Unicode data with a maximum of 8,000 characters.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Text">
<summary>
Variable-length non-Unicode data with a maximum length of 2^31 - 1 (2,147,483,647) characters.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.NChar">
<summary>
Fixed-length Unicode data with a maximum length of 4,000 characters.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.NVarChar">
<summary>
Variable-length Unicode data with a maximum length of 4,000 characters. sysname is a system-supplied user-defined data type that is functionally equivalent to nvarchar(128) and is used to reference database object names.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.NText">
<summary>
Variable-length Unicode data with a maximum length of 2^30 - 1 (1,073,741,823) characters.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Binary">
<summary>
Fixed-length binary data with a maximum length of 8,000 bytes.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.VarBinary">
<summary>
Variable-length binary data with a maximum length of 8,000 bytes.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Image">
<summary>
Variable-length binary data with a maximum length of 2^31 - 1 (2,147,483,647) bytes.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Cursor">
<summary>
A reference to a cursor.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Variant">
<summary>
A data type that stores values of various SQL Server-supported data types, except text, ntext, timestamp, and sql_variant.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Table">
<summary>
A special data type used to store a result set for later processing.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Timestamp">
<summary>
A database-wide unique number that gets updated every time a row gets updated.
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.UniqueIdentifier">
<summary>
Is a 16-byte GUID
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Xml">
<summary>
xml data type
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Date">
<summary>
Date-only
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Time">
<summary>
Time only
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.DateTime2">
<summary>
Combination of data and time types, better precision than DataTime
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.DateTimeOffset">
<summary>
Same as DateTime2 with timezone offset added
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.SqlDataType.Rowversion">
<summary>
(Alias for Timestamp) A database-wide unique number that gets updated every time a row gets updated.
</summary>
</member>
<member name="T:Microsoft.SqlServer.Dac.Model.PermissionType">
<summary>
Sql permissions
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Unknown">
<summary>
Unknown
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Insert">
<summary>
Insert
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Select">
<summary>
Select
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Update">
<summary>
Update
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Delete">
<summary>
Delete
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.References">
<summary>
References
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateDatabase">
<summary>
CreateDatabase
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateDefault">
<summary>
CreateDefault
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateFunction">
<summary>
CreateFunction
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateProcedure">
<summary>
CreateProcedure
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateRule">
<summary>
CreateRule
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateTable">
<summary>
CreateTable
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.CreateView">
<summary>
CreateView
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.BackupDatabase">
<summary>
BackupDatabase
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.BackupLog">
<summary>
BackupLog
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.AdministerBulkOperations">
<summary>
AdministerBulkOperations
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.Alter">
<summary>
Alter
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.AlterAnyApplicationRole">
<summary>
AlterAnyApplicationRole
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.AlterAnyAssembly">
<summary>
AlterAnyAssembly
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.AlterAnyAsymmetricKey">
<summary>
AlterAnyAsymmetricKey
</summary>
</member>
<member name="F:Microsoft.SqlServer.Dac.Model.PermissionType.AlterAnyCertificate">