praveennish opened a new pull request #439:
URL: https://github.com/apache/lucene/pull/439


   <!--
   _(If you are a project committer then you may remove some/all of the 
following template.)_
   
   Before creating a pull request, please file an issue in the ASF Jira system 
for Lucene:
   
   * https://issues.apache.org/jira/projects/LUCENE
   
   You will need to create an account in Jira in order to create an issue.
   
   The title of the PR should reference the Jira issue number in the form:
   
   * LUCENE-####: <short description of problem or changes>
   
   LUCENE must be fully capitalized. A short description helps people scanning 
pull requests for items they can work on.
   
   Properly referencing the issue in the title ensures that Jira is correctly 
updated with code review comments and commits. -->
   
   
   # Description
   
   Lucene currently supports LZ4 and Zlib compression/decompression for 
StoredFieldsFormat. We propose Zstandard (https://facebook.github.io/zstd/) 
compression/decompression for StoredFieldsFormat for the following reasons:
   
   * ZStandard is being used in some of the most popular open source projects 
like Apache Cassandra, Hadoop, and Kafka.
   * Zstandard, at the default setting of 3, is expected to show substantial 
improvements in both compression and decompression speed while compressing at 
the same ratio as Zlib as per study mentioned by Yann Collet at Facebook
   
(https://engineering.fb.com/2016/08/31/core-data/smaller-and-faster-data-compression-with-zstandard/).
   * Zstandard currently offers 22 different Compression levels, which enable 
flexible, granular trade-offs between compression speed and ratios for future 
data. This solution also provides the flexibility of choosing compression 
levels between 1 and 22. For example, we can use level 1 if speed is most 
important and level 22 if the size is most important.
   * Zstandard designed to scale with modern 
hardware(https://engineering.fb.com/2016/08/31/core-data/smaller-and-faster-data-compression-with-zstandard/).
   
   # Solution
   
   * Developed a custom codec to enable Zstandard compression/decompression 
support.
   * This custom codec also provides flexibility to add any other compression 
algorithms.
   
   # Tests
   
   * Added required test case for testing new custom codec. Ran with option 
-Dtests.codec for newly developed custom codec
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [X] I have reviewed the guidelines for [How to 
Contribute](https://wiki.apache.org/lucene/HowToContribute) and my code 
conforms to the standards described there to the best of my ability.
   - [X] I have created a Jira issue and added the issue ID to my pull request 
title.
   - [X] I have given Lucene maintainers 
[access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
 to contribute to my PR branch. (optional but recommended)
   - [X] I have developed this patch against the `main` branch.
   - [X] I have run `./gradlew check`.
   - [X] I have added tests for my changes.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to