Skip to content

Commit

Permalink
Improve wording for using buffers as keys
Browse files Browse the repository at this point in the history
  • Loading branch information
kriszyp committed Dec 11, 2023
1 parent f8069b9 commit 8bb2c6e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ true
'hello'
['hello', 1, 'world']
['hello', 'world']
Buffer.from([255]) // buffers can be used directly, 255 is higher than any byte produced by primitives
Buffer.from([255]) // buffers are used directly, 255 is higher than any byte produced by primitives
```

Keys use 0/null bytes as delimiters for arrays, and so strings currently can not have '\x00' (null char) in them.
Keys use 0/null bytes as delimiters for arrays, and so strings currently can not have '\x00' (null char) in them. Buffers are assumed to be already encoded values, and will not be returned as buffers when read (from range queries).

By default, the maximum key size is 1978 bytes. If you explicitly set the `pageSize` to 8192 or higher, the maximum key size will be 4026, but this is the largest key size supported.

Expand Down

0 comments on commit 8bb2c6e

Please sign in to comment.