-
Notifications
You must be signed in to change notification settings - Fork 616
Drop duplicate MySQL indexes. #24107
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.
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
Merged
+126
−13
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Removed duplicate indexes from the database schema. |
117 changes: 117 additions & 0 deletions
117
server/datastore/mysql/migrations/tables/20241122171434_RemoveDuplicateIndexes.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| package tables | ||
|
|
||
| import ( | ||
| "database/sql" | ||
| "fmt" | ||
| ) | ||
|
|
||
| func init() { | ||
| MigrationClient.AddMigration(Up_20241122171434, Down_20241122171434) | ||
| } | ||
|
|
||
| func Up_20241122171434(tx *sql.Tx) error { | ||
| // Duplicate indexes identified after running pt-duplicate-key-checker | ||
| // https://docs.percona.com/percona-toolkit/pt-duplicate-key-checker.html | ||
|
|
||
| // # ######################################################################## | ||
| // # fleet.app_config_json | ||
| // # ######################################################################## | ||
| // | ||
| // # Uniqueness of id ignored because PRIMARY is a duplicate constraint | ||
| // # id is a duplicate of PRIMARY | ||
| // # Key definitions: | ||
| // # UNIQUE KEY `id` (`id`) | ||
| // # PRIMARY KEY (`id`), | ||
| // # Column types: | ||
| // # `id` int unsigned not null default '1' | ||
| // # To remove this duplicate index, execute: | ||
| // ALTER TABLE `fleet`.`app_config_json` DROP INDEX `id`; | ||
| // | ||
| // # ######################################################################## | ||
| // # fleet.host_users | ||
| // # ######################################################################## | ||
| // | ||
| // # idx_uid_username is a duplicate of PRIMARY | ||
| // # Key definitions: | ||
| // # UNIQUE KEY `idx_uid_username` (`host_id`,`uid`,`username`) | ||
| // # PRIMARY KEY (`host_id`,`uid`,`username`), | ||
| // # Column types: | ||
| // # `host_id` int unsigned not null | ||
| // # `uid` int unsigned not null | ||
| // # `username` varchar(255) collate utf8mb4_unicode_ci not null | ||
| // # To remove this duplicate index, execute: | ||
| // ALTER TABLE `fleet`.`host_users` DROP INDEX `idx_uid_username`; | ||
| // | ||
| // # ######################################################################## | ||
| // # fleet.migration_status_tables | ||
| // # ######################################################################## | ||
| // | ||
| // # Uniqueness of id ignored because PRIMARY is a duplicate constraint | ||
| // # id is a duplicate of PRIMARY | ||
| // # Key definitions: | ||
| // # UNIQUE KEY `id` (`id`) | ||
| // # PRIMARY KEY (`id`), | ||
| // # Column types: | ||
| // # `id` bigint unsigned not null auto_increment | ||
| // # To remove this duplicate index, execute: | ||
| // ALTER TABLE `fleet`.`migration_status_tables` DROP INDEX `id`; | ||
| // | ||
| // # ######################################################################## | ||
| // # fleet.policy_membership | ||
| // # ######################################################################## | ||
| // | ||
| // # idx_policy_membership_policy_id is a left-prefix of PRIMARY | ||
| // # Key definitions: | ||
| // # KEY `idx_policy_membership_policy_id` (`policy_id`), | ||
| // # PRIMARY KEY (`policy_id`,`host_id`), | ||
| // # Column types: | ||
| // # `policy_id` int unsigned not null | ||
| // # `host_id` int unsigned not null | ||
| // # To remove this duplicate index, execute: | ||
| // ALTER TABLE `fleet`.`policy_membership` DROP INDEX `idx_policy_membership_policy_id`; | ||
| // | ||
| // # ######################################################################## | ||
| // # fleet.software | ||
| // # ######################################################################## | ||
| // | ||
| // # Key software_listing_idx ends with a prefix of the clustered index | ||
| // # Key definitions: | ||
| // # KEY `software_listing_idx` (`name`,`id`), | ||
| // # PRIMARY KEY (`id`), | ||
| // # Column types: | ||
| // # `name` varchar(255) collate utf8mb4_unicode_ci not null | ||
| // # `id` bigint unsigned not null auto_increment | ||
| // # To shorten this duplicate clustered index, execute: | ||
| // ALTER TABLE `fleet`.`software` DROP INDEX `software_listing_idx`, ADD INDEX `software_listing_idx` (`name`); | ||
| // | ||
| // # ######################################################################## | ||
| // # fleet.software_cve | ||
| // # ######################################################################## | ||
| // | ||
| // # software_cve_software_id is a left-prefix of unq_software_id_cve | ||
| // # Key definitions: | ||
| // # KEY `software_cve_software_id` (`software_id`) | ||
| // # UNIQUE KEY `unq_software_id_cve` (`software_id`,`cve`), | ||
| // # Column types: | ||
| // # `software_id` bigint unsigned default null | ||
| // # `cve` varchar(255) collate utf8mb4_unicode_ci not null | ||
| // # To remove this duplicate index, execute: | ||
| // ALTER TABLE `fleet`.`software_cve` DROP INDEX `software_cve_software_id`; | ||
|
|
||
| _, err := tx.Exec( | ||
| "ALTER TABLE `app_config_json` DROP INDEX `id`;" + | ||
| "ALTER TABLE `host_users` DROP INDEX `idx_uid_username`;" + | ||
| "ALTER TABLE `migration_status_tables` DROP INDEX `id`;" + | ||
| "ALTER TABLE `policy_membership` DROP INDEX `idx_policy_membership_policy_id`;" + | ||
| "ALTER TABLE `software` DROP INDEX `software_listing_idx`, ADD INDEX `software_listing_idx` (`name`);" + | ||
| "ALTER TABLE `software_cve` DROP INDEX `software_cve_software_id`;", | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to remove duplicate indexes: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func Down_20241122171434(tx *sql.Tx) error { | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm sure those changes all make sense given the usual quality of those percona tools, I'm just worried that some of those tables can be very big (
host_usersand the software ones esp.) and that statement could take a long time to complete (and run into some timeouts?). I vaguely remember us doing something for long migrations, but maybe it's ok to just call it out in the release notes, maybe @lucasmrod remembers something similar?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, I too remember customers having issues with long running migrations (and therefore long offline time). Worth running the migration on a load test environment with ~100k hosts to have an estimate of offline time for customers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I believe this is our standard flow now for load testing. Set up the load test for the previous minor version, then run the migration. But I'll call it out in the QA section.