Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Document zInfo binary format and implementation details #1125

Open
austinvazquez opened this issue Mar 20, 2024 · 1 comment
Open

[Doc] Document zInfo binary format and implementation details #1125

austinvazquez opened this issue Mar 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@austinvazquez
Copy link
Contributor

Description

There is growing interest by the community to build independent SOCI index generators. For example, #1117 documents interest in an independent rust crate and also references ztoc-rs for doing this.

For these users, expanding on the zInfo binary format and implementation details would be helpful to understand the format and contents of the SOCI artifacts.

Describe the solution you'd like

Expand docs/index.md to explicitly document the FlatBuffers format and zInfo implementation details.

Describe any alternative solutions/features you've considered

No response

Any additional context or information about the feature request

This is follow-up to #757

@austinvazquez austinvazquez added the documentation Improvements or additions to documentation label Mar 20, 2024
@aochagavia
Copy link

Great! An additional thing to mention, if anyone picks this up, is in how far the zInfo is tied to a particular compression method (e.g. would it need to be modified if / when SOCI supports zstd?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants