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

Improve set deletions percentage javadoc #12828

Merged
merged 5 commits into from
Jan 22, 2025
Merged
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,10 @@ public double getMaxMergedSegmentMB() {
}

/**
* Controls the maximum percentage of deleted documents that is tolerated in the index. Lower
* values make the index more space efficient at the expense of increased CPU and I/O activity.
* Values must be between 5 and 50. Default value is 20.
* Sets the maximum percentage of deleted documents that is tolerated in the index. The
Copy link
Contributor

@shubhamvishu shubhamvishu Nov 21, 2023

Choose a reason for hiding this comment

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

Maybe it'll be great if we include what @jpountz defined it on the issue here as well since it was easier to understand...."how much of my doc ID space is taken by deleted docs" -> "percentage of doc id space taken by deleted docs". WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review, I will modify the wording.

* denominator includes both active and deleted documents. Lower values make the index more space
* efficient at the expense of increased CPU and I/O activity. Values must be between 5 and 50.
* Default value is 20.
*
* <p>When the maximum delete percentage is lowered, the indexing thread will call for merges more
* often, meaning that write amplification factor will be increased. Write amplification factor
Expand Down
Loading