lucene icon indicating copy to clipboard operation
lucene copied to clipboard

LUCENE-8739: custom codec providing Zstandard compression/decompression

Open praveennish opened this issue 3 years ago • 3 comments

Description

#9784

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 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 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.

praveennish avatar Nov 15 '21 08:11 praveennish

Is this PR going to be merged? What release is this planned for?

ssigut avatar Apr 19 '22 11:04 ssigut

See discussion on LUCENE-8739, this PR is unlikely going to get merged.

jpountz avatar Apr 19 '22 12:04 jpountz

This PR has not had activity in the past 2 weeks, labeling it as stale. If the PR is waiting for review, notify the [email protected] list. Thank you for your contribution!

github-actions[bot] avatar Jan 09 '24 00:01 github-actions[bot]

This PR has not had activity in the past 2 weeks, labeling it as stale. If the PR is waiting for review, notify the [email protected] list. Thank you for your contribution!

github-actions[bot] avatar Mar 23 '24 00:03 github-actions[bot]