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

Document the database schema #17

Open
andrew opened this issue Feb 2, 2021 · 2 comments
Open

Document the database schema #17

andrew opened this issue Feb 2, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@andrew
Copy link
Member

andrew commented Feb 2, 2021

Would be very handy to have a list of the key formats and expected values in leveldb so you don't have to search through the code to find how/where to retrieve some data from.

Some keys off the top of my head:

  • pkg:${manager}:${name} - metadata (json for npm or string for go)
  • cid:${manager}:${name}:${version} - cid string
  • size:${manager}:${name}:${version} - int (bytes)
  • mod:go:${name}:${version} - go.mod contents (string)
  • info:go:${name}:${version} - go metadata (json)
  • latest:go:${name} - go latest version (json)
  • repub:${manager}:${name}:${version}:${peerid} - timestamp
@andrew andrew added the documentation Improvements or additions to documentation label Feb 2, 2021
@andrew andrew added the help wanted Extra attention is needed label Apr 21, 2021
@splashinn
Copy link

does this still need tackled? i can start working on it ASAP if so

@andrew
Copy link
Member Author

andrew commented Aug 28, 2021

Yep, go for it!

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants