SqlServer.AdministrativeViews 1.0.282

.NET 6.0

dotnet tool install --global SqlServer.AdministrativeViews --version 1.0.282

This package contains a .NET tool you can call from the shell/command line.

dotnet new tool-manifest
                    

                            if you are setting up this repo

dotnet tool install --local SqlServer.AdministrativeViews --version 1.0.282

This package contains a .NET tool you can call from the shell/command line.

#tool dotnet:?package=SqlServer.AdministrativeViews&version=1.0.282

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

nuke :add-package SqlServer.AdministrativeViews --version 1.0.282

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SQL Server Administrative Veiws CLI

The intended use of the CLI tool is to provide metrics and execution plans for SQL Server queries for Continuous Integration (CI) scenarios as offline interactive report.

It supports SQL Server 2005...2025 including Local DB.

UI Highlights

Execution plan link to SSMS per query,
Sql syntax highlighter,
Light and dark theme support,
Metrics sorting,
Database filter,
Columns chooser.

Installation

dotnet tool install --global SqlServer.AdministrativeViews

Example

$report = "$($ENV:SYSTEM_ARTIFACTSDIRECTORY)\Reports\{InstanceName} {Version} on {Platform}"
SqlServer.AdministrativeViews -o $report -all

# or 

$report = "$($ENV:GITHUB_TEMP)\Reports\{InstanceName} {Version} on {Platform}"
dotnet dnx SqlServer.AdministrativeViews -o $report -all

GITHUB_TEMP and SYSTEM_ARTIFACTSDIRECTORY are directories that are emptied at the beginning and end of each job on github actions and azure devops.

Options

-o "Reports\{InstanceName}" ⇢ Write a report to a file named as sql server or local db instance in the relative folder Report. Full path is also allowed. Missing folders will be created. {InstanceName} placeholder is useful if multiple SQL Servers are passed. Additional file name placeholders are {Version} and {Platform}.

--all-local-servers, -all ⇢ Include all local sql servers and all Local DB instances. Sql Server Browser service is not required. All instances are discovered by registry and SQL Local DB management API.

-s "(local)\SQLEXPRESS" ⇢ Include local SQLEXPRESS instance.

-cs "TrustServerCertificate=True;Data Source=127.0.0.1,1433;User ID=sa;Password=p@assw0rd!" ⇢ Include SQL Server on Linux, on a network, or in the cloud.

Parameters -s (server instance name), -cs (connection string) may be included multiple times.