Fix overlapping index checking #117

Raveline · 2024-10-09T09:58:56Z

Ensure we check only overlap on the current table and not the whole schema each time we check a table;
Exclude local indexes;
Make sure PK are not taken into account;
Fix test (it was passing for the wrong reasons);

- Ensure we check only overlap on the current table - Exclude local indexes - Make sure PK are not taken into account

Raveline · 2024-10-09T09:59:46Z

src/Database/PostgreSQL/PQTypes/Checks/Util.hs

+    , "             indisunique"
+    , "         AND other_indisunique"
+    , "         AND colindex = colotherindex"
+    , ");"


@marco44 : OK for you ? (Could you please confirm l. 227 and l. 205 seem ok ?)

Seems ok to me

marco44 · 2024-10-09T11:33:29Z

src/Database/PostgreSQL/PQTypes/Checks/Util.hs

+    , "             indisunique"
+    , "         AND other_indisunique"
+    , "         AND colindex = colotherindex"
+    , ");"


Seems ok to me

arybczak · 2024-10-10T12:41:18Z

src/Database/PostgreSQL/PQTypes/Checks/Util.hs

@@ -190,8 +190,8 @@ objectHasMore otype ptype extra =
 arrListTable :: RawSQL () -> Text
 arrListTable tableName = " ->" <+> unRawSQL tableName <> ": "

-checkOverlappingIndexesQuery :: SQL
-checkOverlappingIndexesQuery =
+checkOverlappingIndexesQuery :: SQL -> SQL


Suggested change

checkOverlappingIndexesQuery :: SQL -> SQL

checkOverlappingIndexesQuery :: RawSQL () -> SQL

arybczak · 2024-10-10T12:42:10Z

src/Database/PostgreSQL/PQTypes/Checks.hs

@@ -508,7 +508,7 @@ checkDBStructure options tables = fmap mconcat . forM tables $ \(table, version)
      runQuery_ $ sqlGetForeignKeys table
      fkeys <- fetchMany fetchForeignKey
      triggers <- getDBTriggers tblName
-      checkedOverlaps <- checkOverlappingIndexes
+      checkedOverlaps <- checkOverlappingIndexes (mkSQL . T.pack $ tblNameString table)


Suggested change

checkedOverlaps <- checkOverlappingIndexes (mkSQL . T.pack $ tblNameString table)

checkedOverlaps <- checkOverlappingIndexes (tblName table)

And pass RawSQL () around and inside checkOverlappingIndexesQuery you can use raw function to convert from RawSQL () to SQL. AFAIR this is the general theme of how using RawSQL in constructing SQLs throughout the library is done, so let's be consistent.

arybczak · 2024-10-10T12:42:57Z

src/Database/PostgreSQL/PQTypes/Checks/Util.hs

@@ -201,7 +201,8 @@ checkOverlappingIndexesQuery =
    , "                         , ((regexp_match(pg_get_indexdef(indexrelid)"
    , "                                        , 'WHERE (.*)$')))[1] AS preddef"
    , "                    FROM pg_index"
-    , "                    WHERE indexprs IS NULL)"
+    , "                    WHERE indexprs IS NULL"
+    , "                    AND indrelid = '" <> tableName <> "'::regclass)"


Suggested change

, " AND indrelid = '" <> tableName <> "'::regclass)"

, " AND indrelid = '" <> raw tableName <> "'::regclass)"

arybczak · 2024-10-10T12:43:12Z

src/Database/PostgreSQL/PQTypes/Checks.hs

@@ -714,8 +714,8 @@ checkDBStructure options tables = fmap mconcat . forM tables $ \(table, version)
                     \expected output into source code.)"
                   ]

-        checkOverlappingIndexes :: MonadDB m => m ValidationResult
-        checkOverlappingIndexes =
+        checkOverlappingIndexes :: MonadDB m => SQL -> m ValidationResult


Suggested change

checkOverlappingIndexes :: MonadDB m => SQL -> m ValidationResult

checkOverlappingIndexes :: MonadDB m => RawSQL () -> m ValidationResult

Raveline · 2024-10-18T07:51:33Z

This has been tested against https://github.com/scrive/kontrakcja/pull/7335 with no problems. Are we ok to merge @arybczak ?

arybczak

Let's merge, thanks 👍

Fix overlapping index checking

e0e49a6

- Ensure we check only overlap on the current table - Exclude local indexes - Make sure PK are not taken into account

Raveline commented Oct 9, 2024

View reviewed changes

marco44 approved these changes Oct 9, 2024

View reviewed changes

arybczak reviewed Oct 10, 2024

View reviewed changes

Simplify tablename passing

2d26819

arybczak approved these changes Oct 21, 2024

View reviewed changes

Raveline merged commit a993e40 into master Oct 28, 2024
9 checks passed

Raveline deleted the fix-overlapping-index-checker branch October 28, 2024 07:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix overlapping index checking #117

Fix overlapping index checking #117

Raveline commented Oct 9, 2024

Raveline Oct 9, 2024

marco44 Oct 9, 2024

marco44 Oct 9, 2024

arybczak Oct 10, 2024

arybczak Oct 10, 2024

arybczak Oct 10, 2024

arybczak Oct 10, 2024

Raveline commented Oct 18, 2024

arybczak left a comment

	checkOverlappingIndexesQuery :: SQL -> SQL
	checkOverlappingIndexesQuery :: RawSQL () -> SQL

	checkedOverlaps <- checkOverlappingIndexes (mkSQL . T.pack $ tblNameString table)
	checkedOverlaps <- checkOverlappingIndexes (tblName table)

	, " AND indrelid = '" <> tableName <> "'::regclass)"
	, " AND indrelid = '" <> raw tableName <> "'::regclass)"

	checkOverlappingIndexes :: MonadDB m => SQL -> m ValidationResult
	checkOverlappingIndexes :: MonadDB m => RawSQL () -> m ValidationResult

Fix overlapping index checking #117

Fix overlapping index checking #117

Conversation

Raveline commented Oct 9, 2024

Raveline Oct 9, 2024

Choose a reason for hiding this comment

marco44 Oct 9, 2024

Choose a reason for hiding this comment

marco44 Oct 9, 2024

Choose a reason for hiding this comment

arybczak Oct 10, 2024

Choose a reason for hiding this comment

arybczak Oct 10, 2024

Choose a reason for hiding this comment

arybczak Oct 10, 2024

Choose a reason for hiding this comment

arybczak Oct 10, 2024

Choose a reason for hiding this comment

Raveline commented Oct 18, 2024

arybczak left a comment

Choose a reason for hiding this comment