meilisearch / meilisearch/heed

Document the safety issues with the unnamed database

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation good first issue
Dominant language
Rust
Stars
914
Forks
82
PR merge metrics
No merged PRs in 30d

Description

LMDB has an important restriction on the unnamed database when named ones are opened the names of the named databases are stored as keys in the unnamed one and are immutable.

I faced a big bug that triggered a SIGSEGV when copying all of the entries of one unnamed database into another env, heed tried to write the values associated with the opened named databases multiple times, it triggered SIGSEGV sometimes.

I didn't take the time to reproduce this behavior, but we must, at least, document it!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is identified. Start by locating heed's documentation for unnamed and named LMDB databases, then review the linked LMDB restriction and the reported copy scenario. Done means documenting the restriction, the risk of copying entries from an unnamed database with named databases open, and the observed SIGSEGV caveat without claiming an unreproduced fix.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.