[CASSANDRA-19640] Enhance documentation on storage engine with leading summary

• Type: Improvement
• Status: Resolved
• Priority: Low
• Resolution: Fixed
• Fix Version/s: 5.0.3, 5.1
• Component/s: Documentation
• Change Category: Code Clarity
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/ac36ddd7f644bddafe1493666f592651a57604ca

Test and Documentation Plan

n/a for documentation

• Assignee: Brad Schoening
• Reporter: Brad Schoening

Authors

Brad Schoening

Reviewers

Michael Semb Wever

• Created: 17/May/24 12:43
• Updated: 02/Jan/25 15:40
• Resolved: 02/Jan/25 15:40

Description

The storage engine documentation would benefit from an abstract or summary which mentions key points that it uses a Log-structured merge (LSM) tree design, is write-oriented, and relies upon bloom filters (not B-trees) to optimize the read path.

Issue Links

• links to: PR-3333