Merge pull request #140 from LowlyDBA/development

Development

Author: lowlydba

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Express SQL
+# Contributing to DBA MultiTool
 
-:wave: Hi there! Thanks for using and contributing to the Express SQL suite of scripts!
+:wave: Hi there! Thanks for using and contributing to the DBA MultiTool!
 
 Below are guidelines and helpful approaches for participating in the project.
 
@@ -12,7 +12,7 @@ Below are guidelines and helpful approaches for participating in the project.
 
 You can help contribute by:
 
-* Opening a feature request 
+* Opening a feature request
 * Opening a :bug:
 * Increasing unit test coverage
 * Making a pull request to address any of the above
@@ -35,7 +35,7 @@ want to install them manually) you can run `appveyor\install_dependencies.ps1`
 to get them in addition to TSQLLint (via npm)
 2. If you don't have a [tSQLt][tsqlt] database already, run `appveyor\install_tsqlt.ps1`
 to install a local copy of it
-3. Install the Express SQL Suite with `appveyor\install_expsql.ps1`
+3. Install the DBA MultiTool with `appveyor\install_tool.ps1`
 4. Build the unit tests with `appveyor\build_tsqlt_tests.ps1`
 5. Make any proposed modifications to the scripts
 6. Verify all unit tests pass with `appveyor\run_tsqlt_tests.ps1`
@@ -70,6 +70,6 @@ PowerShell is only used in the automation piece of this project, but could proba
 benefit from being better documented and standardized. Right now no particular
 style is enforced, but one may be used in the future.
 
-[mdconfig]: https://github.com/LowlyDBA/ExpressSQL/blob/master/.github/linters/.markdown-lint.yml
+[mdconfig]: https://github.com/LowlyDBA/dba-multitool/blob/master/.github/linters/.markdown-lint.yml
 [mdlint]: https://github.com/DavidAnson/markdownlint
 [tsqlt]: https://tsqlt.org/

appveyor/appveyor.yml

@@ -1,4 +1,4 @@
-version: 1.3.{build}
+version: 1.4.{build}
 
 pull_requests:
   do_not_increment_build_number: false
@@ -66,7 +66,7 @@ clone_script:
   - git config --global user.email "[email protected]"
   - git config --global user.name "Appveyor"
   - git config --global core.safecrlf false
-  - git clone -q --single-branch --branch=%APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH% https://github.com/LowlyDBA/ExpressSQL.git %APPVEYOR_BUILD_FOLDER%
+  - git clone -q --single-branch --branch=%APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH% https://github.com/LowlyDBA/dba-multitool.git %APPVEYOR_BUILD_FOLDER%
   - cd %APPVEYOR_BUILD_FOLDER%
 
 install:
@@ -76,7 +76,7 @@ install:
 
 build_script:
   - ps: .\appveyor\generate_combined_script.ps1
-  - ps: .\appveyor\install_expsql.ps1
+  - ps: .\appveyor\install_tool.ps1
   - ps: .\appveyor\build_tsqlt_tests.ps1
 
 # Non-covered test run

appveyor/generate_combined_script.ps1

@@ -1,7 +1,8 @@
-$File = "install_expsql.sql"
+$File = "install_dba-multitool.sql"
+$Filter = "sp_*.sql"
 
 if (Test-Path $File) {
     Remove-Item $File
 }
 
-Get-Item sp_*.sql | Get-Content | Out-File $File
+Get-Item $Filter | Get-Content | Out-File $File

appveyor/install_expsql.ps1 renamed to appveyor/install_tool.ps1

@@ -5,17 +5,18 @@ param(
     [bool]$IsAzureSQL = [System.Convert]::ToBoolean($env:AzureSQL),
     [string]$User = $env:AZURE_SQL_USER,
     [string]$Pass = $env:AZURE_SQL_PASS,
-    [string]$Color = "Green"
+    [string]$Color = "Green",
+    [string]$InputFile = "install_dba-multitool.sql"
     )
 
-Write-Host "Installing ExpressSQL scripts..." -ForegroundColor $Color
+Write-Host "Installing DBA MultiTool scripts..." -ForegroundColor $Color
 
 $ErrorActionPreference = "Stop";
 
 If ($IsAzureSQL) {
-    Invoke-SqlCmd -ServerInstance $SqlInstance -Database $Database -InputFile "install_expsql.sql" -Username $User -Password $Pass
+    Invoke-SqlCmd -ServerInstance $SqlInstance -Database $Database -InputFile $InputFile -Username $User -Password $Pass
 }
 Else {
-    Invoke-SqlCmd -ServerInstance $SqlInstance -Database $Database -InputFile "install_expsql.sql"
+    Invoke-SqlCmd -ServerInstance $SqlInstance -Database $Database -InputFile $InputFile
 
 }

appveyor/sqlcover/Coverage.opencoverxml

@@ -3,14 +3,15 @@ CREATE PROCEDURE [dbo].[sp_doc]
 	@DatabaseName SYSNAME = NULL
 	,@ExtendedPropertyName SYSNAME = 'Description'
 	,@LimitStoredProcLength BIT = 1
+	,@Emojis BIT = 0
 	/* Parameters defined here for testing only */
 	,@SqlMajorVersion TINYINT = 0
 	,@SqlMinorVersion SMALLINT = 0
 WITH RECOMPILE
 AS
 
 /*
-sp_doc - Part of the ExpressSQL Suite https://expresssql.lowlydba.com/
+sp_doc - Part of the DBA MultiTool https://expresssql.lowlydba.com/
 
 Version: 09112020
 
@@ -47,8 +48,13 @@ BEGIN
 		,@ParmDefinition NVARCHAR(500)
 		,@QuotedDatabaseName SYSNAME
 		,@Msg NVARCHAR(MAX) 
-		,@LastUpdated NVARCHAR(20) = '2020-09-22';
-
+		,@LastUpdated NVARCHAR(20) = '2020-10-01'
+		-- Variables used for Emoji mode
+		,@Yes VARCHAR(20) = 'yes'
+		,@No VARCHAR(20) = 'no'
+		,@PK VARCHAR(20) = NULL
+		,@FK VARCHAR(20) = NULL
+		,@Column VARCHAR(20) = NULL;
 
 	-- Find Version
 	IF (@SqlMajorVersion = 0)
@@ -67,7 +73,7 @@ BEGIN
 			RAISERROR(@Msg, 16, 1);
 		END;
 
-	--Check database name
+	-- Check database name
 	IF (@DatabaseName IS NULL)
 		BEGIN
 			SET @DatabaseName = DB_NAME();
@@ -78,6 +84,16 @@ BEGIN
 			RAISERROR(@Msg, 16, 1);
 		END;
 
+	-- Check Emoji Mode
+	IF (@Emojis = 1)
+		BEGIN;
+			SET @Yes = ':heavy_check_mark:';
+			SET @No = ':x:';
+			SET @PK = ':key: ';
+			SET @FK = ':old_key: ';
+			SET @Column = ':page_facing_up: ';
+		END;
+
 	SET @QuotedDatabaseName = QUOTENAME(@DatabaseName); --Avoid injections
 
 	--Create table to hold EP data
@@ -162,8 +178,10 @@ BEGIN
 			SELECT CONCAT(''| ''
                     ,CASE 
                         WHEN [ic].[object_id] IS NOT NULL 
-                        THEN ISNULL(CONCAT(''**'',[c].[name],''**''), ''N/A'') 
-                        ELSE ISNULL([c].[name], ''N/A'') 
+                        THEN CONCAT(@PK, ''**'',[c].[name],''**'')
+						WHEN [fk].[parent_object_id] IS NOT NULL
+						THEN CONCAT(@FK, [c].[name])
+                        ELSE CONCAT(@Column, [c].[name])
                     END
 					,'' | ''
 					,CONCAT(UPPER(TYPE_NAME([user_type_id]))
@@ -199,14 +217,14 @@ BEGIN
 					,'' | ''
 					,CASE [c].[is_nullable]
 						WHEN 1
-						THEN ''yes''
-						ELSE ''no''
+						THEN @Yes
+						ELSE @No
 						END
 					,'' | ''
 					,CASE 
-						WHEN [fk].[parent_object_id] IS NULL
-						THEN ''''
-						ELSE CONCAT(''['',QUOTENAME(OBJECT_SCHEMA_NAME([fk].[referenced_object_id])), ''.'', QUOTENAME(OBJECT_NAME([fk].[referenced_object_id])), ''.'', QUOTENAME(COL_NAME([fk].[referenced_object_id], [fk].[referenced_column_id])),'']'',''(#'',LOWER(OBJECT_SCHEMA_NAME([fk].[referenced_object_id])), LOWER(OBJECT_NAME([fk].[referenced_object_id])), '')'')
+						WHEN [fk].[parent_object_id] IS NOT NULL
+						THEN CONCAT(''['',QUOTENAME(OBJECT_SCHEMA_NAME([fk].[referenced_object_id])), ''.'', QUOTENAME(OBJECT_NAME([fk].[referenced_object_id])), ''.'', QUOTENAME(COL_NAME([fk].[referenced_object_id], [fk].[referenced_column_id])),'']'',''(#'',LOWER(OBJECT_SCHEMA_NAME([fk].[referenced_object_id])), LOWER(OBJECT_NAME([fk].[referenced_object_id])), '')'')
+						ELSE ''''
                     END
 					,'' | ''
 					,OBJECT_DEFINITION([dc].[object_id])
@@ -408,8 +426,8 @@ BEGIN
 					,'' | ''
 					,CASE [c].[is_nullable]
 						WHEN 1
-						THEN ''yes''
-						ELSE ''no''
+						THEN @Yes
+						ELSE @No
 						END
 					,'' | ''
 					,CAST([ep].[value] AS VARCHAR(8000))
@@ -536,8 +554,8 @@ BEGIN
 						,'' | ''
 						,CASE [is_output]
 							WHEN 1
-							THEN ''yes''
-							ELSE ''no''
+							THEN @Yes
+							ELSE @No
 						END
 						,'' | ''
 						,CAST([ep].[value] AS VARCHAR(8000))
@@ -679,8 +697,8 @@ BEGIN
 						,'' | ''
 						,CASE [is_output]
 							WHEN 1
-							THEN ''yes''
-							ELSE ''no''
+							THEN @Yes
+							ELSE @No
 							END
 						,'' | ''
 						,CAST([ep].[value] AS VARCHAR(8000))
@@ -804,8 +822,8 @@ BEGIN
 						,'' | ''
 						,CASE [is_output]
 							WHEN 1
-							THEN ''yes''
-							ELSE ''no''
+							THEN @Yes
+							ELSE @No
 							END
 						,'' | ''
 						,CAST([ep].[value] AS VARCHAR(8000))
@@ -916,10 +934,144 @@ BEGIN
 		--End collapsible synonyms section
 		+ N'INSERT INTO #markdown
 		VALUES (CONCAT(CHAR(13), CHAR(10), ''</details>''));
-	END;' --End markdown for synonyms
+	END;'; --End markdown for synonyms
+
+	/***********************************************
+	Generate markdown for user defined table types
+	***********************************************/
+	--Build table of contents 
+	SET @Sql = @Sql + N'
+	IF EXISTS (SELECT 1 FROM [sys].[all_objects] WHERE [type] = ''TT'')
+	BEGIN
+		INSERT INTO #markdown (value)
+		VALUES (CONCAT(CHAR(13), CHAR(10), ''## User Defined Table Types''))
+			,(CONCAT(CHAR(13), CHAR(10), ''<details><summary>Click to expand</summary>'', CHAR(13), CHAR(10)));
+		' +
+
+		+ N'INSERT INTO #markdown (value)
+		SELECT CONCAT(''* ['', SCHEMA_NAME([schema_id]), ''.'', [name], ''](#'', REPLACE(LOWER(SCHEMA_NAME([schema_id])), '' '', ''-''), REPLACE(LOWER([name]), '' '', ''-''), '')'')
+		FROM [sys].[table_types]
+		WHERE [is_user_defined] = 1
+		ORDER BY OBJECT_SCHEMA_NAME([type_table_object_id]), [name] ASC;' +
+
+		--Object details
+		+ N'DECLARE Obj_Cursor CURSOR 
+		LOCAL STATIC READ_ONLY FORWARD_ONLY
+		FOR 
+		SELECT [type_table_object_id]
+		FROM [sys].[table_types]
+		WHERE [is_user_defined] = 1
+		ORDER BY OBJECT_SCHEMA_NAME([type_table_object_id]), [name] ASC;
+
+		OPEN Obj_Cursor
+		FETCH NEXT FROM Obj_Cursor INTO @objectid
+		WHILE @@FETCH_STATUS = 0
+		BEGIN 
+
+			INSERT INTO #markdown
+			SELECT CONCAT(CHAR(13), CHAR(10), ''### '', SCHEMA_NAME([schema_id]), ''.'', [name])
+			FROM [sys].[table_types]
+			WHERE [type_table_object_id] = @objectid;' +
+
+			--Extended Properties
+			+ N'INSERT INTO #markdown
+			SELECT CONCAT(CHAR(13), CHAR(10), CAST([ep].[value] AS VARCHAR(8000)))
+			FROM [sys].[all_objects] AS [o] 
+				INNER JOIN [sys].[extended_properties] AS [ep] ON [o].[object_id] = [ep].[major_id]
+			WHERE [o].[object_id] = @objectid
+				AND [ep].[minor_id] = 0 --On the table
+				AND [ep].[name] = @ExtendedPropertyName;
+
+			INSERT INTO #markdown (value)
+			VALUES ('''')
+				,(CONCAT(''| Column | Type | Null | Default | '', @ExtendedPropertyName COLLATE DATABASE_DEFAULT, '' |''))
+				,(''| --- | ---| --- | --- | --- |'');' +
+
+			--Columns
+			+ N'INSERT INTO #markdown
+			SELECT CONCAT(''| ''
+                    ,CASE 
+                        WHEN [ic].[object_id] IS NOT NULL 
+                        THEN ISNULL(CONCAT(''**'',[c].[name],''**''), ''N/A'') 
+                        ELSE ISNULL([c].[name], ''N/A'') 
+                    END
+					,'' | ''
+					,CONCAT(UPPER(TYPE_NAME([c].[user_type_id]))
+					,CASE 
+							WHEN TYPE_NAME([c].[user_type_id]) IN (N''decimal'',N''numeric'') 
+							THEN CONCAT(N''('',CAST([c].[precision] AS VARCHAR(5)), N'','',CAST([c].[scale] AS varchar(5)), N'')'')
+							WHEN TYPE_NAME([c].[user_type_id]) IN (''varchar'', ''char'', ''varbinary'')
+							THEN CASE
+									WHEN [c].[max_length] = -1
+									THEN N''(MAX)'' 
+									ELSE QUOTENAME(CAST([c].[max_length] AS VARCHAR(10)), ''('')
+								END
+							WHEN TYPE_NAME([c].[user_type_id]) IN (N''time'',N''datetime2'',N''datetimeoffset'') 
+							THEN QUOTENAME(CAST([c].[scale] AS VARCHAR(5)), ''('')
+							WHEN TYPE_NAME([c].[user_type_id]) in (N''float'')
+							THEN CASE 
+									WHEN [c].precision = 53 
+									THEN N''''
+									ELSE CONCAT(N''('',CAST([c].[precision] AS VARCHAR(5)),N'')'') 
+								END
+							WHEN TYPE_NAME([c].[user_type_id]) IN (N''int'',N''bigint'',N''smallint'',N''tinyint'',N''money'',N''smallmoney'',
+								N''real'',N''datetime'',N''smalldatetime'',N''bit'',N''image'',N''text'',N''uniqueidentifier'',
+								N''date'',N''ntext'',N''sql_variant'',N''hierarchyid'',''geography'',N''timestamp'',N''xml'') 
+							THEN N''''
+							WHEN TYPE_NAME([c].[user_type_id]) IN (N''nvarchar'',N''nchar'', N''sysname'') 
+							THEN CASE
+									WHEN [c].[max_length] = -1
+									THEN N''(MAX)''
+									ELSE QUOTENAME(CAST([c].[max_length]/2 AS VARCHAR(10)), ''('')
+								END
+							ELSE QUOTENAME(CAST([c].[max_length] AS VARCHAR(10)), ''('')
+					END)
+					,'' | ''
+					,CASE [c].[is_nullable]
+						WHEN 1
+						THEN @Yes
+						ELSE @No
+						END
+					,'' | ''
+					,OBJECT_DEFINITION([dc].[object_id])
+					,'' | ''
+					,CAST([ep].[value] AS VARCHAR(8000))
+					,'' |'')
+			FROM [sys].[table_types] AS [tt] 
+				INNER JOIN [sys].[columns] AS [c] ON [tt].[type_table_object_id] = [c].[object_id]
+				LEFT JOIN [sys].[extended_properties] AS [ep] ON [tt].[type_table_object_id] = [ep].[major_id]
+					AND [ep].[minor_id] > 0
+					AND [ep].[minor_id] = [c].[column_id]
+					AND [ep].[class] = 1 --Object/col
+				--	AND [ep].[name] = @ExtendedPropertyName
+				LEFT JOIN [sys].[foreign_key_columns] AS [fk] ON [fk].[parent_object_id] = [c].[object_id]
+					AND [fk].[parent_column_id] = [c].[column_id]
+				LEFT JOIN [sys].[default_constraints] [dc] ON [dc].[parent_object_id] = [c].[object_id]
+					AND [dc].[parent_column_id] = [c].[column_id]
+				LEFT JOIN [sys].[indexes] AS [pk] ON [pk].[object_id] = [tt].[type_table_object_id]
+					AND [pk].[is_primary_key] = 1
+				LEFT JOIN [sys].[index_columns] AS [ic] ON [ic].[index_id] = [pk].[index_id]
+					AND [ic].[object_id] = [tt].[type_table_object_id]
+					AND [ic].[column_id] = [c].[column_id]
+			WHERE [tt].[type_table_object_id] = @objectid;' +
+
+			--Back to top
+			+ N'INSERT INTO #markdown
+			VALUES (CONCAT(CHAR(13), CHAR(10), ''[Back to top](#'', LOWER(@DatabaseName COLLATE DATABASE_DEFAULT), '')''))
+
+			FETCH NEXT FROM Obj_Cursor INTO @objectid;
+
+		END;
+		CLOSE Obj_Cursor;
+		DEALLOCATE Obj_Cursor;' +
+
+		--End collapsible table section
+		+ N'INSERT INTO #markdown
+		VALUES (CONCAT(CHAR(13), CHAR(10), ''</details>''));
+	END;'; --End markdown for user defined table types
 
 	--Attribution
-	+ N'INSERT INTO #markdown
+	SET @Sql = @Sql + N'INSERT INTO #markdown
 	VALUES (CONCAT(CHAR(13), CHAR(10), ''----''))
 		,(CONCAT(CHAR(13), CHAR(10), ''*Markdown generated by [sp_doc](https://expresssql.lowlydba.com/)''))
 		,(CONCAT('' at '', SYSDATETIMEOFFSET(), ''.*''));';
@@ -930,12 +1082,17 @@ BEGIN
 	FROM #markdown
 	ORDER BY [ID] ASC;';
 
-	SET @ParmDefinition = N'@ExtendedPropertyName SYSNAME, @DatabaseName SYSNAME, @LimitStoredProcLength BIT';
+	SET @ParmDefinition = N'@ExtendedPropertyName SYSNAME, @DatabaseName SYSNAME, @LimitStoredProcLength BIT, @Yes VARCHAR(20), @No VARCHAR(20), @PK VARCHAR(20), @FK VARCHAR(20), @Column VARCHAR(20)';
 	EXEC sp_executesql @Sql
 		,@ParmDefinition
 		,@ExtendedPropertyName
 		,@DatabaseName
-		,@LimitStoredProcLength;
+		,@LimitStoredProcLength
+		,@Yes
+		,@No
+		,@PK
+		,@FK
+		,@Column;
 END;