Skip to content

Commit

Permalink
doc: add more doc to Config::block_size
Browse files Browse the repository at this point in the history
  • Loading branch information
marvin-j97 committed Jan 18, 2024
1 parent 8fd2c67 commit aa8760e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,12 @@ impl Config {
///
/// Defaults to 4 KiB (4096 bytes).
///
/// For point read heavy workloads (get) a sensible default is
/// somewhere between 1 - 8 KiB, depending on the average value size.
///
/// For scan heavy workloads (range, prefix), use 16 - 64 KiB
/// which also increases compression efficiency.
///
/// # Panics
///
/// Panics if the block size is smaller than 1 KiB (1024 bytes).
Expand Down

0 comments on commit aa8760e

Please sign in to comment.