sp_helpme - add incl col (#267)

* remove accident file * add included cols for index output * update copyright date * Updated bundled installer * follow column naming convention * Updated bundled installer * remove appveyor ci * exclude lint rule * Updated bundled installer * clean up docs * only return result set if rows * improve unit test independence from tsqlt schema * Updated bundled installer * improve unit tests * fix typo * fix test * ignore lint for autogen file * skip ci for artifact * fix db context * pluralize col to match existing * Updated bundled installer [skip ci] * tsqllint cant peek inside dynamic sql * Updated bundled installer [skip ci] * fix ssl issues * fix ssl in unit tests * fix sp_doc artifact ssl issue Co-authored-by: lowlydba <[email protected]>
lowlydba · Jan 24, 2023 · beb9f04 · beb9f04
1 parent ee62ae8
commit beb9f04
Show file tree

Hide file tree

Showing 19 changed files with 190 additions and 272 deletions.
diff --git a/.github/workflows/artifacts.yml b/.github/workflows/artifacts.yml
@@ -42,5 +42,5 @@ jobs:
       - name: Commit bundled installer script
         uses: stefanzweifel/[email protected]
         with:
-          commit_message: Updated bundled installer
+          commit_message: Updated bundled installer [skip ci]
           file_pattern: ${{ env.INSTALLER_FILE }}
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -8,6 +8,8 @@ on:
     branches:
       - main
   pull_request:
+    paths-ignore:
+      - install_dba-multitool.sql
 
 jobs:
   build:

diff --git a/.github/workflows/sqlserver-unit.yml b/.github/workflows/sqlserver-unit.yml
@@ -80,11 +80,11 @@ jobs:
       - name: Update SqlServer Module
         run: |
           Install-Module SqlServer -AllowClobber -AllowPreRelease -Force
-      
+
       - name: Install multitool
         run: |
           foreach ($script in (Get-ChildItem -Path "." -Filter "sp_*.sql").Name) {
-            Invoke-Sqlcmd -ServerInstance $Env:SQLINSTANCE -Database $Env:DATABASE -InputFile $script
+            Invoke-Sqlcmd -InputFile $script -ConnectionString "Data Source=$Env:SQLINSTANCE;Initial Catalog=$Env:DATABASE;Integrated Security=True;TrustServerCertificate=true"
           }
 
       - name: Run Pester tests with SQLCover
@@ -105,7 +105,7 @@ jobs:
         run: |
           Write-Output "Generating '$Env:SAMPLE_DATABASE' markdown sample."
           $Query = "EXEC sp_doc @DatabaseName = '$Env:SAMPLE_DATABASE';"
-          Invoke-SqlCmd -ServerInstance $Env:SQLINSTANCE -Database $Env:DATABASE -Query $Query -As DataRows | Select-Object -ExpandProperty 'value' | Out-File "$($Env:SAMPLE_DATABASE)-$($Env:SQL_VERSION).md"
+          Invoke-SqlCmd -Query $Query -As DataRows -ConnectionString "Data Source=$Env:SQLINSTANCE;Initial Catalog=$Env:DATABASE;Integrated Security=True;TrustServerCertificate=true" | Select-Object -ExpandProperty 'value' | Out-File "$($Env:SAMPLE_DATABASE)-$($Env:SQL_VERSION).md"
 
       - name: Upload sp_doc sample artifact
         uses: actions/upload-artifact@v3

diff --git a/appveyor/appveyor.yml b/appveyor/appveyor.yml
diff --git a/appveyor/install_dependencies.ps1 b/appveyor/install_dependencies.ps1
diff --git a/appveyor/install_tsqlt.ps1 b/appveyor/install_tsqlt.ps1
diff --git a/appveyor/run_pester_tests.ps1 b/appveyor/run_pester_tests.ps1
diff --git a/appveyor/start_sqlserver.ps1 b/appveyor/start_sqlserver.ps1
diff --git a/docs/README.md b/docs/README.md
@@ -14,10 +14,6 @@ optimizing storage, on-the-fly documentation, general administrative needs,
 and more. Each script relies solely on T-SQL to ensure it is secure,
 requires no third-party software, and can be installed in seconds.
 
-All open source, all free to use under the MIT license.
-
-Check the below list for technical documentation on each script.
-
 ## Scripts
 
 To quickly install/update all the scripts, use install_dba-multitool.sql
@@ -34,7 +30,7 @@ For detailed instructions and documentation, see [dba-multitool.org](https://dba
 
 ## Compatibility
 
-Tested against versions that are still in the standard support lifecycle.
+Only support for versions that are still in [mainstream][mainstream] support is guaranteed.
 
 | Version | Tested |
 | ------- | :----: |
@@ -57,17 +53,13 @@ Tested against versions that are still in the standard support lifecycle.
 <sub>*Icon made by [mangsaabguru](https://www.flaticon.com/authors/mangsaabguru)
 from [www.flaticon.com](https://www.flaticon.com/)*</sub>
 
-[appveyor]: https://ci.appveyor.com/project/LowlyDBA/dba-multitool
-[azure-badge]: https://img.shields.io/badge/Azure%20SQL-vCurrent-blue?logo=data:image/svg+xml;base64,PHN2ZyBkYXRhLXNsdWctaWQ9InNxbC1kYXRhYmFzZS1ibHVlIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0OSA0OSI+DQogIDxwYXRoIGQ9Im02LjQwNDIxIDcuNDA0NDJ2MzQuMTk1NzhjMCAzLjUyNDMgNy44ODk2OSA2LjQ3NzIgMTcuNjgwMzkgNi40Nzcydi00MC42NzI5OHoiIGZpbGw9IiM4MDgwODAiLz4NCiAgPHBhdGggZD0ibTIzLjg5NDYgNDguMDc3NGguMjg1MmM5Ljc5MDcgMCAxNy42ODA0LTIuODU3NiAxNy42ODA0LTYuNDc3MnYtMzQuMTk1NzhoLTE3Ljk2NTZ6IiBmaWxsPSIjODA4MDgwIi8+DQogIDxwYXRoIGQ9Im0yMy43MDQzIDQ4LjA3NzloLjI4NTJjOS44ODU4IDAgMTcuOTY1Ni0yLjg1NzYgMTcuOTY1Ni02LjQ3NzJ2LTM0LjI5MTAxaC0xOC4xNTU3eiIgZmlsbD0iIzgwODA4MCIvPg0KICA8cGF0aCBkPSJtNDEuODU4NCA3LjQwNTUzYzAgMy41MjQzNy03Ljg4OTcgNi40NzcxNy0xNy42ODA1IDYuNDc3MTctOS43OTA3IDAtMTcuNjgwMzktMi44NTc2LTE3LjY4MDM5LTYuNDc3MTcgMC0zLjYxOTYgNy44ODk2OS02LjQ3NzE4NSAxNy42ODAzOS02LjQ3NzE4NSA5Ljc5MDggMCAxNy42ODA1IDIuOTUyODM1IDE3LjY4MDUgNi40NzcxODV6IiBmaWxsPSIjZmZmIi8+PHBhdGggZD0ibTM4LjI0ODEgNy4wMjM4YzAgMi4zODEzMi02LjI3MzcgNC4yODY0LTE0LjA2ODMgNC4yODY0cy0xNC4wNjgzLTEuOTA1MDgtMTQuMDY4My00LjI4NjQgNi4yNzM3LTQuMjg2MzcgMTQuMDY4My00LjI4NjM3IDE0LjA2ODMgMS45MDUwNSAxNC4wNjgzIDQuMjg2Mzd6IiBmaWxsPSIjODA4MDgwIi8+DQogIDxwYXRoIGQ9Im0zNS4zMDEzIDkuNTk1NjNjMS44MDYxLS43NjIwMiAyLjk0NjgtMS42MTkzIDIuOTQ2OC0yLjU3MTgzIDAtMi4zODEzMi02LjI3MzctNC4yODYzNy0xNC4wNjgzLTQuMjg2MzdzLTE0LjA2ODMgMS45MDUwNS0xNC4wNjgzIDQuMjg2MzdjMCAuOTUyNTMgMS4xNDA3IDEuOTA1MDYgMi45NDY3IDIuNTcxODMgMi41NjY1LTEuMDQ3NzggNi42NTQtMS42MTkzIDExLjEyMTYtMS42MTkzczguNTU1LjY2Njc3IDExLjEyMTUgMS42MTkzeiIgZmlsbD0iIzgwODA4MCIvPg0KICA8ZyBmaWxsPSIjZmZmIj4NCiAgICA8cGF0aCBkPSJtMTguNDc1MiAzMS4xMjJjMCAxLjA0NzgtLjM4MDMgMS45MDUxLTEuMTQwNyAyLjQ3NjYtLjc2MDUuNTcxNS0xLjgwNjEuODU3My0zLjIzMTkuODU3My0xLjE0MDcgMC0yLjA5MTMtLjE5MDUtMi44NTE3LS42NjY4di0yLjQ3NjZjLjg1NTUuNzYyMSAxLjkwMTEgMS4xNDMxIDIuOTQ2NyAxLjE0MzEuNDc1MyAwIC45NTA2LS4wOTUzIDEuMjM1OC0uMjg1OC4yODUxLS4xOTA1LjM4MDItLjQ3NjIuMzgwMi0uODU3MyAwLS4zODEtLjA5NTEtLjY2NjctLjM4MDItLjg1NzItLjI4NTItLjI4NTgtLjg1NTUtLjU3MTUtMS43MTEtLjk1MjYtMS43MTExLS43NjItMi41NjY2LTEuOTA1LTIuNTY2Ni0zLjIzODYgMC0xLjA0NzcuMzgwMy0xLjgwOTggMS4xNDA3LTIuMzgxMy43NjA1LS41NzE1IDEuNzExLS45NTI1IDIuOTQ2Ny0uOTUyNSAxLjA0NTcgMCAxLjk5NjIuMTkwNSAyLjc1NjcuNDc2M3YyLjM4MTNjLS43NjA1LS40NzYzLTEuNjE2LS43NjItMi41NjY1LS43NjItLjQ3NTMgMC0uODU1NS4wOTUyLTEuMTQwNy4yODU3cy0uMzgwMi40NzYzLS4zODAyLjg1NzMuMDk1LjY2NjguMzgwMi44NTczYy4xOTAxLjE5MDUuNjY1NC40NzYyIDEuNDI1OC44NTcyIDEuMDQ1Ni40NzYzIDEuODA2MS45NTI2IDIuMjgxNCAxLjUyNDEuMjg1MS4zODEuNDc1My45NTI1LjQ3NTMgMS43MTQ1eiIvPjxwYXRoIGQ9Im0yNy44ODY4IDI4Ljc0MTJjMC0xLjE0My0uMjg1Mi0yLjAwMDMtLjc2MDQtMi42NjcxLS40NzUzLS42NjY3LTEuMTQwNy0uOTUyNS0xLjk5NjItLjk1MjVzLTEuNjE2LjI4NTgtMi4wOTEzLjk1MjVjLS41NzAzLjY2NjgtLjc2MDQgMS41MjQxLS43NjA0IDIuNjY3MSAwIDEuMDQ3OC4yODUyIDIuMDAwMy43NjA0IDIuNjY3MS40NzUzLjY2NjggMS4yMzU4Ljk1MjUgMi4wOTEzLjk1MjVzMS41MjA5LS4yODU3IDIuMDkxMi0uOTUyNWMuMzgwMi0uNjY2OC42NjU0LTEuNTI0MS42NjU0LTIuNjY3MXptMi42NjE2LS4wOTUyYzAgMS4zMzM1LS4yODUyIDIuNDc2NS0uODU1NSAzLjQyOTEtLjU3MDQuOTUyNS0xLjQyNTkgMS42MTkzLTIuNTY2NSAyLjAwMDNsMy4yMzE5IDMuMDQ4MWgtMy4yMzE5bC0yLjI4MTQtMi41NzE5Yy0uOTUwNiAwLTEuOTAxMS0uMjg1Ny0yLjY2MTYtLjc2Mi0uNzYwNC0uNDc2My0xLjQyNTgtMS4xNDMtMS44MDYtMi4wMDAzLS40NzUzLS44NTczLS42NjU0LTEuODA5OC0uNjY1NC0yLjg1NzYgMC0xLjE0My4xOTAxLTIuMTkwOC42NjU0LTMuMTQzMy40NzUzLS45NTI2IDEuMTQwNi0xLjYxOTMgMS45OTYyLTIuMDk1Ni44NTU1LS40NzYzIDEuODA2LS43NjIgMi45NDY3LS43NjIgMS4wNDU2IDAgMS45OTYyLjE5MDUgMi43NTY2LjY2NjguODU1NS40NzYyIDEuNDI1OSAxLjE0MyAxLjkwMTEgMi4wMDAzLjM4MDMuOTUyNS41NzA0IDEuOTA1LjU3MDQgMy4wNDgxeiIvPjxwYXRoIGQ9Im0zOS4xMDM2IDM0LjI2NTNoLTYuNzQ5di0xMS4xNDQ2aDIuNTY2NnY5LjE0NDNoNC4xODI0eiIvPg0KICA8L2c+DQo8L3N2Zz4NCg==
-[codecov]: https://codecov.io/gh/LowlyDBA/dba-multitool
 [contrib]: ../.github/CONTRIBUTING.md
 [dbatools]: https://dbatools.io
 [issue]: https://github.com/LowlyDBA/dba-multitool/issues
 [license]: ../LICENSE
-[lint]: https://github.com/LowlyDBA/dba-multitool/actions?query=workflow%3A%22Lint+Code+Base%22
+[mainstream]: https://learn.microsoft.com/en-us/sql/sql-server/end-of-support/sql-server-end-of-support-overview?view=sql-server-ver16#lifecycle-dates
 [slack]: https://sqlcommunity.slack.com/archives/C026Y2YCM9N
 [sp_doc]: https://dba-multitool.org/sp_doc
 [sp_estindex]: https://dba-multitool.org/sp_estindex
 [sp_helpme]: https://dba-multitool.org/sp_helpme
 [sp_sizeoptimiser]: https://dba-multitool.org/sp_sizeoptimiser
-[sqlserver-badge]: https://img.shields.io/badge/SQL%20Server-2012--2019-blue?logo=microsoft-sql-server
diff --git a/install_dba-multitool.sql b/install_dba-multitool.sql
@@ -90,7 +90,7 @@ Version: 20211223
 
 MIT License
 
-Copyright (c) 2022 John McCall
+Copyright (c) 2023 John McCall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation
@@ -2356,7 +2356,7 @@ Version: 20220124
 
 MIT License
 
-Copyright (c) 2022 John McCall
+Copyright (c) 2023 John McCall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation
@@ -3205,11 +3205,11 @@ sp_helpme - A drop-in modern alternative to sp_help.
 
 Part of the DBA MultiTool http://dba-multitool.org
 
-Version: 20220124
+Version: 20230108
 
 MIT License
 
-Copyright (c) 2022 John McCall
+Copyright (c) 2023 John McCall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation
@@ -3570,7 +3570,58 @@ BEGIN
 	IF @SysObj_Type IN ('S ','U ')
 	BEGIN
 		EXEC sys.sp_objectfilegroup @ObjID;
+
+		/* Begin custom included columns for sp_helpindex */
+		CREATE TABLE #sp_helpindex (
+			index_name SYSNAME COLLATE database_default
+			,index_description VARCHAR(210)
+			,index_keys NVARCHAR(2126) COLLATE database_default  --Length (16*max_identifierLength)+(15*2)+(16*3)
+			,index_includes NVARCHAR(MAX)	--Length (1023*max_identifierLength)+(15*2)+(16*3) is > 4000
+		);
+		INSERT INTO #sp_helpindex (index_name, index_description, index_keys)
 		EXEC sys.sp_helpindex @ObjectName;
+
+		IF EXISTS (SELECT 1 FROM #sp_helpindex)
+		BEGIN
+			SET @SQLString = N'
+				WITH includedColumns AS (
+					SELECT DISTINCT i2.name AS index_name
+						, LTRIM(STUFF((
+							SELECT '', '' + c.name
+							FROM sys.indexes i
+						INNER JOIN ' + QUOTENAME(DB_NAME()) + '.sys.index_columns ic ON i.index_id = ic.index_id
+						INNER JOIN ' + QUOTENAME(DB_NAME()) + '.sys.columns c ON c.column_id = ic.column_id
+					WHERE i.object_id = @ObjID
+						AND ic.object_id = @ObjID
+						AND c.object_id = @ObjID
+						AND ic.is_included_column = 1
+						AND i2.index_id = i.index_id
+							FOR XML PATH(''''), TYPE).value(''.'', ''NVARCHAR(MAX)''), 1, 1, '''')) AS included
+					FROM ' + QUOTENAME(DB_NAME()) + '.sys.indexes i2
+						INNER JOIN #sp_helpindex sp ON sp.index_name COLLATE database_default = i2.name
+						INNER JOIN ' + QUOTENAME(DB_NAME()) + '.sys.index_columns ic ON i2.index_id = ic.index_id
+					WHERE i2.object_id = @ObjID
+						AND ic.object_id = @ObjID
+						AND ic.is_included_column = 1
+				)
+				UPDATE sp
+				SET sp.index_includes = ic.included
+				FROM #sp_helpindex sp
+					INNER JOIN includedColumns ic ON sp.index_name COLLATE database_default = ic.index_name;';
+			SET @ParmDefinition = N'@ObjID INT';
+
+			EXEC sp_executesql @SQLString
+				,@ParmDefinition
+				,@ObjID;
+		END
+
+		IF EXISTS (SELECT 1 FROM #sp_helpindex)
+		BEGIN
+			SELECT index_name, index_description, index_keys, index_includes
+			FROM #sp_helpindex;
+		END
+		/* End custom included columns for sp_helpindex */
+
 		EXEC sys.sp_helpconstraint @ObjectName,'nomsg';
 
 		SET @SQLString = N'SELECT @HasDepen = COUNT(1)
@@ -3753,7 +3804,7 @@ Version: 20220818
 
 MIT License
 
-Copyright (c) 2022 John McCall
+Copyright (c) 2023 John McCall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation