docs: section 11 of the storage design still lists runtime backend selection

Open Beginner friendly
#891 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 4 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read section 11 of docs/design/04-component-storage.md, then compare its runtime backend selection claim with crates/bin/src/main.rs and crates/storage/src/backend.rs. Check section 1 and in_catalog_create_only in crates/server/src/backup_store.rs alongside the changes in #700 and #668. Update section 11 to match the build-time backend selection and include the in-catalog backup step for backends that cannot pin a table snapshot.

Written by the indexing model from the issue text.

Description

documentation

Section 11.8 of docs/design/04-component-storage.md lists "Runtime backend selection (choose backend from config file)" as a reason for trait objects. Each binary has one backend, and the build chooses it. crates/bin/src/main.rs stops the build with compile_error! unless exactly one backend feature is on, and main installs that backend with set_backend (crates/storage/src/backend.rs).

Section 11 also has no step for a backend that cannot pin a table snapshot. Since #700, such a backend needs an entry in in_catalog_create_only in crates/server/src/backup_store.rs, so that its CreateBackup writes the in-catalog format. #668 adds this to section 1 of the same file.

Dominant language
Rust
Stars
517
Forks
60
Avg merge
5d 3h
Merged PRs (30d)
79

Getting set up

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.

More from ExtendDB/extenddb

All issues in ExtendDB/extenddb

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.