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

Index documentation #306

Open
MichaelMure opened this issue Jun 2, 2022 · 1 comment
Open

Index documentation #306

MichaelMure opened this issue Jun 2, 2022 · 1 comment
Assignees
Labels
exp/intermediate Prior experience is likely helpful help wanted Seeking public contribution on this issue

Comments

@MichaelMure
Copy link
Contributor

I'm trying to grasp how the indexes in this repo work, what they are good for, the pro/cons of each, but I end up reading the code to try to figure out what's happening.

Would you mind writing a minimal doc for each explaining those? That'd really help.

@rvagg rvagg added help wanted Seeking public contribution on this issue exp/intermediate Prior experience is likely helpful labels Jun 6, 2022
@willscott
Copy link
Member

There's a first pass at documentation at https://ipld.io/specs/transport/car/carv2/#index-format

In practice, we've ended up basically only using the 'MultihashIndexSorted' variant because we do want to be able to use the index for iteration of multihashes in addition to lookups. The tradeoff is that 'MultihashIndexSorted' is slightly larger but allows that, while 'IndexSorted' is slightly smaller but does not (because it doesn't include the multihash algorithms used, only the digests.)

@rvagg rvagg self-assigned this Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exp/intermediate Prior experience is likely helpful help wanted Seeking public contribution on this issue
Projects
Status: 🗄️ Backlog
Development

No branches or pull requests

3 participants