Home

Documentation

Overview

SQL Power Doc is a collection of Windows PowerShell scripts and modules that discover, document, and diagnose SQL Server instances and their underlying Windows OS & machine configurations. SQL Power Doc works with all versions of SQL Server from SQL Server 2000 through 2012, and all versions of Windows Server and consumer Windows Operating Systems (e.g. XP) from Windows 2000 through Windows Server 2012 and Windows 8. SQL Power Doc is also capable of documenting Windows Azure SQL Databases.

Guides & Documentation

What's Documented

• SQL Power Doc collects exhaustive information about your SQL Server instances - more than any other documentation tool period. Here's the complete list.

SQL Power Doc Requirements

• Start here for a complete list of what's required to use SQL Power Doc

How To Guide For PowerShell Beginners

• If you've never touched Windows PowerShell before, or even if you have but you're a bit shaky on installing modules and running scripts, this is where you'll want to start. This guide provides a detailed walkthrough of everything you need to do to use SQL Power Doc.

How To Perform A Windows Inventory

• SQL Power Doc isn't limited to just SQL Server - because it collects information about Windows it can also be used to perform an inventory of your entire Windows environment. This guide will show you how.

Version History

• Version 1.0.2.2 (View Changelog)
  • Added version recognition for SQL 2014
  • Misc. bug fixes & functional improvements
  • Updated code gathering database permissions to include objects not found in sys.objects but which have permissions on them (e.g. Assemblies, Asymmetric Keys, Certificates, etc.)
• Version 1.0.2.1 (View Changelog)
  • Misc. bug fixes
  • Added logic to resolve members of a Windows Group server login
  • Added columns to Excel workbooks to show definitions for server permissions, server roles, database permissions, and database roles
• Version 1.0.2.0 (View Changelog)
  • Misc. bug fixes
• Version 1.0.1.0  (View Changelog)
  • Improved error handling in several modules
  • Fixed bugs reported since version 1.0.0.0
  • Added 11 new & updated 3 existing database engine assessment checks
• Version 1.0.0.0
  • Initial Release

Acknowledgements

• The NetShell module included with SQL Power Doc is distributed with permission from Chris Dent
• The inspiration for several of the diagnostic checks in SQL Power Doc came from Brent Ozar Unlimited's sp_Blitz™ stored procedure. While they do similar things, sp_Blitz™ looks at some things that are beyond the scope of SQL Power Doc. If you've looking to squeeze every bit of performance out of a SQL Server instance sp_Blitz™ is a great resource to check out.

Post-Acknowledgements and Attributions!

• This repository was cloned from kendalvandyke, the original author of SQLPowerDoc. Codeplex is currently in the process of shutting down. I cloned this project (and its wiki) with the intention of preserving a wonderful tool that I recently discovered. While the original author had permission to use NetShell by Chris Dent, I do not. As such, while still in the current source, I intend to remove the use of NetShell. Eventually.
• I will also not provide a branch for the 1.0.0.0 - 1.0.2.2 releases as they depend on NetShell (Due to the way GitHub works, I can't prevent anyone from downloading the initial commits that contain them, but it is not my intent to re-release said releases).
• As per the first 2 points, the first release from this repo will have a different version numbering scheme and will not have NetShell included.