Skip to content

PS-9822 Improve documentation on MyRocks variables (8.0) #517

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

Open
wants to merge 1 commit into
base: 8.0
Choose a base branch
from

Conversation

patrickbirch
Copy link
Collaborator

On branch ps-9822
modified: docs/variables.md

@patrickbirch patrickbirch changed the title PS-9721 Improve documentation on MyRocks variables (8.0) PS-9822 Improve documentation on MyRocks variables (8.0) Jun 6, 2025
@patrickbirch patrickbirch requested a review from inikep June 6, 2025 16:52
 On branch ps-9822
	modified:   docs/variables.md
Enabling `rocksdb_enable_pipelined_write` activates this feature. It is
especially useful in workloads with high concurrency or transaction phases
that generate bursts of write activity, such as the prepare step in
two-phase commit protocols.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original text: beneficial in
a) workloads with multiple concurrent writers [and]
b) in scenarios like the prepare phase of a two-phase commit

"prepare phase" should stay because it's a proper name:
Two-Phase Commit (2PC) is a distributed algorithm used to ensure atomicity across multiple systems or databases in a transaction. It ensures that either all participants commit the transaction or none of them do, preventing data inconsistency.
Phase 1: Prepare (Voting Phase)
Phase 2: Commit (Decision Phase)



RocksDB uses pipelined writes to increase throughput in workloads with
concurrent writers. When the Write-Ahead Log (WAL) is enabled, write
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original text: The pipelined write feature in RocksDB is designed to improve concurrent write throughput when the Write-Ahead Log (WAL) is enabled.
We lost info that The pipelined write feature works only if Write-Ahead Log (WAL) is enabled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants