Skip to content

replacing btree index with unique index for performance gains #40054

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

Open
wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

jakwinkler
Copy link

@jakwinkler jakwinkler commented Jul 8, 2025

Description (*)

Replacing btree index with unique index for performance gains in catalog_product_entity_media_gallery_value table. Thanks to that we also assure data integrity.

Fixed Issues (if relevant)

  1. Fixes Consider adding a unique key to catalog_product_entity_media_gallery_value #36190

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Copy link

m2-assistant bot commented Jul 8, 2025

Hi @jakwinkler. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR replaces a non-unique btree index on catalog_product_entity_media_gallery_value(entity_id, value_id, store_id) with a unique constraint to improve query performance and enforce data integrity.

  • Changed an existing btree index to a unique constraint
  • Renamed the index reference to include a _UNQ suffix
  • Ensures duplicate rows on (entity_id, value_id, store_id) cannot be inserted
Comments suppressed due to low confidence (3)

app/code/Magento/Catalog/etc/db_schema.xml:887

  • [nitpick] Add a brief XML comment above this line explaining why a unique constraint is used (performance benefits and data integrity) so future maintainers understand the change.
        <constraint referenceId="CAT_PRD_ENTT_MDA_GLR_VAL_ENTT_ID_VAL_ID_STORE_ID_UNQ" xsi:type="unique">

app/code/Magento/Catalog/etc/db_schema.xml:887

  • Add an integration test to verify that inserting a duplicate (entity_id, value_id, store_id) row is rejected by this new unique constraint.
        <constraint referenceId="CAT_PRD_ENTT_MDA_GLR_VAL_ENTT_ID_VAL_ID_STORE_ID_UNQ" xsi:type="unique">

app/code/Magento/Catalog/etc/db_schema.xml:887

  • Consider benchmarking insert/update operations on catalog_product_entity_media_gallery_value after this change to ensure write performance remains acceptable.
        <constraint referenceId="CAT_PRD_ENTT_MDA_GLR_VAL_ENTT_ID_VAL_ID_STORE_ID_UNQ" xsi:type="unique">

@ihor-sviziev
Copy link
Contributor

@magento run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider adding a unique key to catalog_product_entity_media_gallery_value
2 participants