Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix overlapping index checking #117

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix overlapping index checking #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0e49a6
Fix overlapping index checking
Raveline Oct 1, 2024
2d26819
Simplify tablename passing
Raveline Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Database/PostgreSQL/PQTypes/Checks.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 tblName
return $
mconcat
[ checkColumns 1 tblColumns desc
Expand Down Expand Up @@ -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 => RawSQL () -> m ValidationResult
checkOverlappingIndexes tableName =
if eoCheckOverlappingIndexes options
then go
else pure mempty
Expand All @@ -728,7 +728,7 @@ checkDBStructure options tables = fmap mconcat . forM tables $ \(table, version)
, " contains index "
, contained
]
runSQL_ checkOverlappingIndexesQuery
runSQL_ $ checkOverlappingIndexesQuery tableName
overlaps <- fetchMany handleOverlap
pure $
if null overlaps
Expand Down
19 changes: 13 additions & 6 deletions src/Database/PostgreSQL/PQTypes/Checks/Util.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,8 @@ objectHasMore otype ptype extra =
arrListTable :: RawSQL () -> Text
arrListTable tableName = " ->" <+> unRawSQL tableName <> ": "

checkOverlappingIndexesQuery :: SQL
checkOverlappingIndexesQuery =
checkOverlappingIndexesQuery :: RawSQL () -> SQL
checkOverlappingIndexesQuery tableName =
smconcat
[ "WITH"
, -- get predicates (WHERE clause) definition in text format (ugly but the parsed version
Expand All @@ -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 = '" <> raw tableName <> "'::regclass)"
, -- add the rest of metadata and do the join
" , indexdata2 AS (SELECT t1.*"
, " , pg_get_indexdef(t1.indexrelid) AS contained"
Expand All @@ -218,13 +219,19 @@ checkOverlappingIndexesQuery =
, " SELECT contained"
, " , contains"
, " FROM indexdata2"
, " JOIN pg_class c ON (c.oid = indexdata2.indexrelid)"
, -- The indexes are the same or the "other" is larger than us
" WHERE (colotherindex = colindex"
, " OR colotherindex LIKE colindex || '+%')"
, -- and this is not a local index
" AND NOT c.relname ILIKE 'local_%'"
, -- and we have the same predicate
" AND other_preddef IS NOT DISTINCT FROM preddef"
, -- and either the other is unique (so better than us) or none of us is unique
" AND (other_indisunique"
, " OR (NOT other_indisunique"
, " AND NOT indisunique));"
" AND (NOT indisunique)"
, " OR ("
, " indisunique"
, " AND other_indisunique"
, " AND colindex = colotherindex"
, ");"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems ok to me

]
15 changes: 13 additions & 2 deletions test/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2166,7 +2166,18 @@ overlapingIndexesTests connSource = do
testCaseSteps' "Overlapping indexes tests" connSource $ \step -> do
freshTestDB step

step "Check that overlapping indexes get flagged"
step "Migration is correct if not checking for overlapping indexes"
do
let options = defaultExtrasOptions {eoCheckOverlappingIndexes = False}
migrateDatabase
options
["pgcrypto"]
[]
[]
[table1]
[createTableMigration table1]

step "Migration invalid when flagging overlapping indexes"
do
let options = defaultExtrasOptions {eoCheckOverlappingIndexes = True}
assertException "Some indexes are overlapping" $
Expand All @@ -2181,7 +2192,7 @@ overlapingIndexesTests connSource = do
table1 :: Table
table1 =
tblTable
{ tblName = "idxTest"
{ tblName = "idx_test"
, tblVersion = 1
, tblColumns =
[ tblColumn {colName = "id", colType = UuidT, colNullable = False}
Expand Down
Loading