Skip to content

Commit

Permalink
add note about how payload size is handled
Browse files Browse the repository at this point in the history
  • Loading branch information
andylamp authored Nov 8, 2023
1 parent ec87170 commit 7911be7
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,16 @@ all of the available pages so far; this in turn let's us create an index very fa
without having to pay costly reads if we wanted to have a clustered tree (although
we again use more space, usually).

## Payload sizes

Due to inherent limitations of how B+ Tree is designed to work the payload contained
within each entry must be of a specific size. This can be configured at initialization
but cannot be changed after creation.

This means that if the payload is _less_ than the entry size it will be padded with
whitespaces to fill in the bucket whereas if it is _more_ it will be truncuated to
the size of the bucket.

# License

This work, at its current version, is licensed under the Apache 2.0 license.
Expand Down

0 comments on commit 7911be7

Please sign in to comment.