rocksdb

database/rocksdb

Fork 0

mirror of https://github.com/facebook/rocksdb.git synced 2026-10-24 19:59:35 +03:00

Commit Graph

Author	SHA1	Message	Date
Xingbo Wang	50852b5c8d	db_stress: document expected-state trace/replay contract (#14612 ) Summary: - add a `docs/components/` landing page and a stress-test docs index - document the `db_stress` expected-state trace/replay lifecycle, file invariants, and prefix-recovery contract in `expected_state_trace.md` - align `db_stress` comments with the restore semantics: missing trace entries are fatal, while extra tail trace entries are tolerated - keep the new docs tree trackable and point repo instructions at the new component-docs entrypoint ## Testing - Not run (documentation and comment updates only) Pull Request resolved: https://github.com/facebook/rocksdb/pull/14612 Reviewed By: joshkang97 Differential Revision: D100797173 Pulled By: xingbowang fbshipit-source-id: 25be8c6239b9fdd84580818efe7520c371f9a46b	2026-04-14 09:58:20 -07:00
Xingbo Wang	24fac74206	docs: add end-to-end flow documentation (read_flow, write_flow) (#14486 ) Summary: Add comprehensive flow documentation tracing data through the full RocksDB system. ## Contents ### read_flow/ (11 chapters) Get/MultiGet/Iterator paths through SuperVersion, MemTable, block cache, SST files (L0→Ln), bloom filters, range deletions, prefetch, async I/O. ### write_flow/ (10 chapters) Put/Delete/Merge through WAL, MemTable, flush, compaction, delete cleanup, flow control, crash recovery, performance. ## Documentation Pattern Each component follows a consistent structure: - `index.md` — short overview (40-80 lines) with chapter table and key characteristics - `NN_topic.md` — deep-dive chapters with source file references and workflow descriptions All content validated against current codebase. No code snippets — refers to header files and struct/function names. Part 1 of 11 in the RocksDB AI documentation series. Pull Request resolved: https://github.com/facebook/rocksdb/pull/14486 Reviewed By: anand1976 Differential Revision: D97795679 Pulled By: xingbowang fbshipit-source-id: 07c3be1a7f27e0a9cc1d82ccad16e8e4084f4ab0	2026-04-01 13:02:17 -07:00

Author

SHA1

Message

Date

Xingbo Wang

50852b5c8d

db_stress: document expected-state trace/replay contract (#14612 )

Summary:
- add a `docs/components/` landing page and a stress-test docs index
- document the `db_stress` expected-state trace/replay lifecycle, file invariants, and prefix-recovery contract in `expected_state_trace.md`
- align `db_stress` comments with the restore semantics: missing trace entries are fatal, while extra tail trace entries are tolerated
- keep the new docs tree trackable and point repo instructions at the new component-docs entrypoint

## Testing
- Not run (documentation and comment updates only)

Pull Request resolved: https://github.com/facebook/rocksdb/pull/14612

Reviewed By: joshkang97

Differential Revision: D100797173

Pulled By: xingbowang

fbshipit-source-id: 25be8c6239b9fdd84580818efe7520c371f9a46b

2026-04-14 09:58:20 -07:00

Xingbo Wang

24fac74206

docs: add end-to-end flow documentation (read_flow, write_flow) (#14486 )

Summary:
Add comprehensive flow documentation tracing data through the full RocksDB system.

## Contents

### read_flow/ (11 chapters)
Get/MultiGet/Iterator paths through SuperVersion, MemTable, block cache, SST files (L0→Ln), bloom filters, range deletions, prefetch, async I/O.

### write_flow/ (10 chapters)
Put/Delete/Merge through WAL, MemTable, flush, compaction, delete cleanup, flow control, crash recovery, performance.

## Documentation Pattern
Each component follows a consistent structure:
- `index.md` — short overview (40-80 lines) with chapter table and key characteristics
- `NN_topic.md` — deep-dive chapters with source file references and workflow descriptions

All content validated against current codebase. No code snippets — refers to header files and struct/function names.

Part 1 of 11 in the RocksDB AI documentation series.

Pull Request resolved: https://github.com/facebook/rocksdb/pull/14486

Reviewed By: anand1976

Differential Revision: D97795679

Pulled By: xingbowang

fbshipit-source-id: 07c3be1a7f27e0a9cc1d82ccad16e8e4084f4ab0

2026-04-01 13:02:17 -07:00

2 Commits