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.

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

DE-743 | MDI/ZKD Indexes #316

Merged
merged 5 commits into from
Feb 2, 2024
Merged

DE-743 | MDI/ZKD Indexes #316

merged 5 commits into from
Feb 2, 2024

Conversation

aMahanna
Copy link
Member

@aMahanna aMahanna commented Jan 16, 2024

Internal discussions have established that an mdi index is an alias for a zkd index, similar to the hash index & persistent index situation.

Given that python-arango never had support for zkd index creation, this PR introduces both add_zkd_index and add_mdi_index

i.e

  • MDI (>=3.12)
  • ZKD (<3.12)

Ref: https://docs.arangodb.com/3.12/index-and-search/indexing/working-with-indexes/multi-dimensional-indexes/

Happy to address this in another way, perhaps there's no need for 2 methods?

arango/collection.py Outdated Show resolved Hide resolved
(zkd & mdi indexes don't support the `sparse` property`
@aMahanna aMahanna changed the title wip: DE-743 | MDI/ZKD Indexes DE-743 | MDI/ZKD Indexes Jan 25, 2024
allows us to test with a nightly build, e.g `3.12.0-NIGHTLY.20240116`
@codecov-commenter
Copy link

Codecov Report

Attention: 8 lines in your changes are missing coverage. Please review.

Comparison is base (99f5d9b) 98.45% compared to head (b93971a) 98.26%.

Files Patch % Lines
arango/collection.py 55.55% 8 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #316      +/-   ##
==========================================
- Coverage   98.45%   98.26%   -0.19%     
==========================================
  Files          26       26              
  Lines        4136     4154      +18     
==========================================
+ Hits         4072     4082      +10     
- Misses         64       72       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aMahanna aMahanna requested a review from apetenchea January 26, 2024 16:30
Copy link
Member

@apetenchea apetenchea left a comment

Choose a reason for hiding this comment

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

LGTM

@aMahanna
Copy link
Member Author

aMahanna commented Feb 2, 2024

After internal discussions, this PR will be merged, but the following changes will be made to index creation:

  • Make _add_index public
  • Set a deprecation warning to all individual add_*_index methods
  • Update indexes.rst to use the generalized add_index method
  • Remove ZKD/MDI add index method, keep existing tests (reworked for add_index)

@aMahanna aMahanna merged commit 9eeb3ec into main Feb 2, 2024
52 checks passed
@aMahanna aMahanna deleted the DE-743 branch February 2, 2024 20:42
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.

3 participants