Skip to content

Add high-level docs to vortex-btrblocks#6984

Merged
connortsui20 merged 1 commit intodevelopfrom
ct/compress-docs
Mar 16, 2026
Merged

Add high-level docs to vortex-btrblocks#6984
connortsui20 merged 1 commit intodevelopfrom
ct/compress-docs

Conversation

@connortsui20
Copy link
Contributor

Summary

Decided to add some docs to vortex-btrblocks as I went through it to try and understand it better.

Testing

N/A

Signed-off-by: Connor Tsui <connor.tsui20@gmail.com>
@connortsui20 connortsui20 added the changelog/docs A docs change label Mar 16, 2026
Copy link
Contributor

@AdamGS AdamGS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love it

Comment on lines +28 to +31
//! Each type-specific compressor holds a static list of `Scheme` implementations (e.g.
//! BitPacking, ALP, Dict). There is no dynamic registry. The compressor evaluates each scheme by
//! compressing a ~1% sample and measuring the ratio, then picks the best. See `SchemeExt` for
//! details on how sampling works.
Copy link
Contributor

@joseph-isaacs joseph-isaacs Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type-specific one has encodings switched on or off

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we should likely allow fully dynamic

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is kind of the point of why I was trying to understand this better, I am going to see if we can easily make the compressor pluggable (so that we can compress extension types into custom encodings).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You would need to add schemas to a registry?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, or something potentially more complicated, or a reworking of how we register schemes in the first place

@connortsui20 connortsui20 added changelog/docs A docs change and removed changelog/docs A docs change labels Mar 16, 2026
@connortsui20 connortsui20 enabled auto-merge (squash) March 16, 2026 16:41
@connortsui20 connortsui20 disabled auto-merge March 16, 2026 16:42
@connortsui20 connortsui20 merged commit aa33a86 into develop Mar 16, 2026
111 of 115 checks passed
@connortsui20 connortsui20 deleted the ct/compress-docs branch March 16, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/docs A docs change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants