Add option to disable automatic index creation#18
Merged
SimonCropp merged 1 commit intomainfrom Feb 4, 2026
Merged
Conversation
Introduce a createIndexes option to UseDefaultOrderBy (default true) to allow disabling automatic index creation. Propagate the flag through OrderRequiredExtension and UseDefaultOrderByConventionPlugin; add IndexCreationDisabledAnnotation and conditionally register the OrderByIndexConvention. OrderByBuilder now checks the model annotation and throws if WithIndexName() is used when index creation is disabled. Update extension info (log fragment, service provider hash, debug info) to include the new option. Add tests to verify no indexes are created and that WithIndexName() throws when disabled, and update README/snippet references accordingly.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduce a createIndexes option to UseDefaultOrderBy (default true) to allow disabling automatic index creation. Propagate the flag through OrderRequiredExtension and UseDefaultOrderByConventionPlugin; add IndexCreationDisabledAnnotation and conditionally register the OrderByIndexConvention. OrderByBuilder now checks the model annotation and throws if WithIndexName() is used when index creation is disabled. Update extension info (log fragment, service provider hash, debug info) to include the new option. Add tests to verify no indexes are created and that WithIndexName() throws when disabled, and update README/snippet references accordingly.