Update sp_IndexCleanup.sql

Author: erikdarlingdata

sp_IndexCleanup/sp_IndexCleanup.sql

@@ -16,29 +16,30 @@ GO
 ALTER PROCEDURE
     dbo.sp_IndexCleanup
 (
-    @database_name sysname = NULL,
-    @schema_name sysname = NULL,
-    @table_name sysname = NULL,
-    @min_reads bigint = 0,
-    @min_writes bigint = 0,
-    @min_size_gb decimal(10,2) = 0,
-    @min_rows bigint = 0,
-    @dedupe_only bit = 0, /*only perform deduplication, don't mark unused indexes for removal*/
-    @get_all_databases bit = 0, /*looks for all accessible user databases and returns combined results*/
+    @database_name sysname = NULL, /*focus on a single database*/
+    @schema_name sysname = NULL, /*use when focusing on a single table, does not filter to a single schema*/
+    @table_name sysname = NULL, /*use when focusing on a single table*/
+    @min_reads bigint = 0, /*only look at indexes with a minimum number of reads*/
+    @min_writes bigint = 0, /*only look at indexes with a minimum number of writes*/
+    @min_size_gb decimal(10,2) = 0, /*only look at indexes with a minimum size*/
+    @min_rows bigint = 0, /*only look at indexes with a minimum number of rows*/
+    @dedupe_only bit = 'false', /*only perform deduplication, don't mark unused indexes for removal*/
+    @get_all_databases bit = 'false', /*looks for all accessible user databases and returns combined results*/
     @include_databases nvarchar(max) = NULL, /*comma-separated list of databases to include (only when @get_all_databases = 1)*/
     @exclude_databases nvarchar(max) = NULL, /*comma-separated list of databases to exclude (only when @get_all_databases = 1)*/
-    @help bit = 'false',
-    @debug bit = 'false',
-    @version varchar(20) = NULL OUTPUT,
-    @version_date datetime = NULL OUTPUT
+    @help bit = 'false', /*learn about the procedure and parameters*/
+    @debug bit = 'false', /*print dynamic sql, show temp table contents*/
+    @version varchar(20) = NULL OUTPUT, /*script version number*/
+    @version_date datetime = NULL OUTPUT /*script version date*/
 )
 WITH RECOMPILE
 AS
 BEGIN
 SET NOCOUNT ON;
-
 BEGIN TRY
-    /* Check for SQL Server 2012 (11.0) or later for FORMAT and CONCAT functions*/
+    SELECT
+        @version = '1.4',
+        @version_date = '20250401';
 
     IF
     /* Check SQL Server 2012+ for FORMAT and CONCAT functions */
@@ -67,10 +68,6 @@ BEGIN TRY
         RETURN;
     END;
 
-    SELECT
-        @version = '1.4',
-        @version_date = '20250401';
-
     /*
     Help section, for help.
     Will become more helpful when out of beta.
@@ -90,7 +87,10 @@ BEGIN TRY
             help = N'always validate all changes against a non-production environment!'
           UNION ALL
         SELECT
-            help = N'please test carefully.';
+            help = N'please test carefully.'
+          UNION ALL
+        SELECT
+            help = N'brought to you by erikdarling.com / code.erikdarling.com';
 
         /*
         Parameters
@@ -285,22 +285,22 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             END;
 
     /* Auto-enable dedupe_only mode if server uptime is low */
-    IF CONVERT(integer, @uptime_days) < 7 AND @dedupe_only = 0
+    IF CONVERT(integer, @uptime_days) <= 7 AND @dedupe_only = 0
     BEGIN
         IF @debug = 1
         BEGIN
             RAISERROR('Server uptime is less than 7 days. Automatically enabling @dedupe_only mode.', 0, 1) WITH NOWAIT;
         END;
 
-        SELECT @dedupe_only = 1;
+        SET @dedupe_only = 1;
     END;
 
     /*
     Initial checks for object validity
     */
     IF @debug = 1
     BEGIN
-        RAISERROR('Checking paramaters...', 0, 0) WITH NOWAIT;
+        RAISERROR('Checking parameters...', 0, 0) WITH NOWAIT;
     END;
 
     IF  @schema_name IS NULL
@@ -311,8 +311,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             RAISERROR('Parameter @schema_name cannot be NULL when specifying a table, defaulting to dbo', 10, 1) WITH NOWAIT;
         END;
 
-        SELECT
-            @schema_name = N'dbo';
+        SET @schema_name = N'dbo';
     END;
 
     IF @min_reads < 0
@@ -591,7 +590,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     CREATE TABLE
         #index_reporting_stats
     (
-        summary_level varchar(20) NOT NULL,  /* 'DATABASE', 'TABLE', 'INDEX', 'SUMMARY' */
+        summary_level varchar(20) NOT NULL, /* 'DATABASE', 'TABLE', 'INDEX', 'SUMMARY' */
         database_name sysname NULL,
         schema_name sysname NULL,
         table_name sysname NULL,
@@ -864,8 +863,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                 N'rdsadmin'
             )
         BEGIN
-            SELECT
-                @database_name = DB_NAME();
+            SET @database_name = DB_NAME();
         END;
 
         /* Single database mode */
@@ -892,7 +890,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             /* Get the database_id for backwards compatibility */
             SELECT
                 @current_database_id = d.database_id
-            FROM #databases AS d;
+            FROM #databases AS d
+            OPTION(RECOMPILE);
         END;
     END
     ELSE
@@ -1128,7 +1127,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         )';
     END;
 
-
     IF @object_id IS NOT NULL
     BEGIN
         IF @debug = 1
@@ -2246,13 +2244,13 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                 (
                     SELECT
                         1/0
-                    FROM #index_details AS  id
+                    FROM #index_details AS id
                     WHERE id.index_id = #index_analysis.index_id
                     AND   id.object_id = #index_analysis.object_id
                     AND   id.user_scans > 0
                 ) THEN 100 ELSE 0
-            END
-    OPTION(RECOMPILE);  /* Indexes with scans get some priority */
+            END /* Indexes with scans get some priority */
+    OPTION(RECOMPILE);  
 
     IF @debug = 1
     BEGIN
@@ -2291,8 +2289,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             AND   id.is_unique_constraint = 0  /* Don't disable unique constraints */
             AND   id.is_eligible_for_dedupe = 1 /* Only eligible indexes */
         )
-        AND #index_analysis.index_id <> 1
-        OPTION(RECOMPILE);  /* Don't disable clustered indexes */
+        AND #index_analysis.index_id <> 1 /* Don't disable clustered indexes */
+        OPTION(RECOMPILE);  
     END;
 
     IF @debug = 1
@@ -2358,7 +2356,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         AND   id2_uc.index_id = ia2.index_id
         AND   id2_uc.is_unique_constraint = 1
     )
-    AND   EXISTS
+    AND EXISTS
     (
         SELECT
             1/0
@@ -2670,7 +2668,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         CASE
             /* If both have includes, combine them without duplicates */
             WHEN kss.superset_includes IS NOT NULL
-            AND kss.subset_includes IS NOT NULL
+            AND  kss.subset_includes IS NOT NULL
             THEN
                 /* Create combined includes using XML method that works with all SQL Server versions */
                 (
@@ -2746,7 +2744,9 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     UPDATE
         ia2
     SET
-        ia2.superseded_by = N'Supersedes ' + ia1.index_name
+        ia2.superseded_by = 
+            N'Supersedes ' + 
+            ia1.index_name
     FROM #index_analysis AS ia1
     JOIN #index_analysis AS ia2
       ON  ia1.database_id = ia2.database_id
@@ -2782,7 +2782,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             END
     FROM #index_analysis AS ia1
     WHERE ia1.consolidation_rule IS NULL /* Not already processed */
-    AND ia1.action IS NULL /* Not already processed by earlier rules */
+    AND   ia1.action IS NULL /* Not already processed by earlier rules */
     AND EXISTS
     (
         /* Find nonclustered indexes */
@@ -3676,7 +3676,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         /* Sort duplicate/subset indexes first (20), then unused indexes last (25) */
         sort_order =
             CASE
-                WHEN ia.consolidation_rule LIKE 'Unused Index%' THEN 25
+                WHEN ia.consolidation_rule LIKE 'Unused Index%' 
+                THEN 25
                 ELSE 20
             END,
         ia.database_name,
@@ -3959,16 +3960,20 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     OPTION(RECOMPILE);
 
     /* If any clustered indexes were added, mark them as KEEP */
-    UPDATE #index_analysis
-    SET action = N'KEEP'
-    WHERE index_id = 1 /* Clustered indexes */
-    AND   action IS NULL;
+    UPDATE 
+        #index_analysis
+    SET 
+        #index_analysis.action = N'KEEP'
+    WHERE #index_analysis.index_id = 1 /* Clustered indexes */
+    AND   #index_analysis.action IS NULL;
 
     /* Update index priority for clustered indexes to ensure they're not chosen for deduplication */
-    UPDATE #index_analysis
-    SET index_priority = 1000 /* Maximum priority */
-    WHERE index_id = 1 /* Clustered indexes */
-    AND   index_priority IS NULL;
+    UPDATE 
+        #index_analysis
+    SET 
+        #index_analysis.index_priority = 1000 /* Maximum priority */
+    WHERE #index_analysis.index_id = 1 /* Clustered indexes */
+    AND   #index_analysis.index_priority IS NULL;
 
     IF @debug = 1
     BEGIN
@@ -4461,7 +4466,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         script_type =
             CASE
                 /* Add compression status to script_type */
-                WHEN ce.can_compress = 1 THEN 'KEPT - NEEDS COMPRESSION'
+                WHEN ce.can_compress = 1 
+                THEN 'KEPT - NEEDS COMPRESSION'
                 ELSE 'KEPT'
             END,
         ia.consolidation_rule,
@@ -4849,7 +4855,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         total_min_savings_gb =
             (
                 SELECT
-                    SUM(
+                    SUM
+                    (
                         CASE
                             WHEN subia.action = N'DISABLE'
                             THEN subps.total_space_gb
@@ -4874,7 +4881,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         total_max_savings_gb =
             (
                 SELECT
-                    SUM(
+                    SUM
+                    (
                         CASE
                             WHEN subia.action = N'DISABLE'
                             THEN subps.total_space_gb
@@ -5097,7 +5105,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         total_min_savings_gb =
             (
                 SELECT
-                    SUM(
+                    SUM
+                    (
                         CASE
                             WHEN subia.action = N'DISABLE'
                             THEN subps.total_space_gb
@@ -5124,7 +5133,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
         total_max_savings_gb =
             (
                 SELECT
-                    SUM(
+                    SUM
+                    (
                         CASE
                             WHEN subia.action = N'DISABLE'
                             THEN subps.total_space_gb
@@ -5302,13 +5312,13 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             ROW_NUMBER() OVER
             (
                 PARTITION BY
-                    database_name,
-                    schema_name,
-                    table_name,
-                    index_name,
+                    irs.database_name,
+                    irs.schema_name,
+                    irs.table_name,
+                    irs.index_name,
                     irs.script_type
                 ORDER BY
-                    result_type DESC /* Prefer non-NULL result types */
+                    irs.result_type DESC /* Prefer non-NULL result types */
             ) AS rn
         FROM #index_cleanup_results AS irs
     ) AS ir
@@ -5537,7 +5547,9 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                         WHEN ISNULL(irs.unused_indexes, 0) > 0
                         THEN FORMAT
                              (
-                                 CONVERT(decimal(38,2),
+                                 CONVERT
+                                 (
+                                     decimal(38,2),
                                      ISNULL
                                      (
                                          irs.user_updates /
@@ -5609,7 +5621,9 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                         THEN
                             FORMAT
                             (
-                                CONVERT(decimal(38,2),
+                                CONVERT
+                                (
+                                    decimal(38,2),
                                     ISNULL
                                     (
                                         (irs.row_lock_wait_count + irs.page_lock_wait_count) /
@@ -5695,7 +5709,9 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                         THEN
                             FORMAT
                             (
-                                CONVERT(decimal(38,2),
+                                CONVERT
+                                (
+                                    decimal(38,2),
                                     ISNULL
                                     (
                                         (irs.page_latch_wait_count + irs.page_io_latch_wait_count) /