Skip to content

Add more (high-level) details about Pebble compression features#23245

Open
rmloveland wants to merge 2 commits intomainfrom
20260430-DOC-16758-pebble-compression-features
Open

Add more (high-level) details about Pebble compression features#23245
rmloveland wants to merge 2 commits intomainfrom
20260430-DOC-16758-pebble-compression-features

Conversation

@rmloveland
Copy link
Copy Markdown
Contributor

Fixes DOC-16758

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 30, 2026

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 5f4a184
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/69f8d49873ef0f0008aae6c7

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 30, 2026

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 5f4a184
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/69f8d49848be3a0008309c2c

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 30, 2026

Netlify Preview

Name Link
🔨 Latest commit 5f4a184
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/69f8d4988585c70007d29b65
😎 Deploy Preview https://deploy-preview-23245--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread src/current/v26.1/architecture/storage-layer.md Outdated
Comment thread src/current/v26.1/architecture/storage-layer.md Outdated

The output CSV file is periodically rewritten while the command is running. Even if the command is interrupted, you can still use the most recently written output.

### Interpret results
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I don't think we should encourage customers to interpret these results in their current form. We should say that they should just consult us with the data.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i have revised this section a bit with a new title, and clarified that the output is not really designed for end users, and they should contact Support - hope it's clearer now, please let me know!


Changing `storage.sstable.compression_algorithm` does not immediately recompress existing SST files. SSTs are immutable, so a new setting applies as Pebble writes new SSTs or rewrites existing SSTs during compaction, ingestion, restore, or other SST-writing work. During a transition, a store can contain SSTs compressed with multiple algorithms.

To evaluate the compression behavior of an existing store or backup, use [`cockroach debug pebble db analyze-data`]({% link {{ page.version.version }}/cockroach-debug-pebble-db-analyze-data.md %}). Compare the compression ratio with the compression and decompression throughput for representative data before changing the cluster setting.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd say "To evaluate the CPU usage vs size tradeoff on your particular data, use .."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated! based on your other comment about not encouraging users to change this themselves, i also updated the second sentence to clarify that they should review the results with us before changing the cluster setting

To evaluate the CPU usage vs. size tradeoff for your particular data, use [cockroach debug pebble db analyze-data]({% link {{ page.version.version }}/cockroach-debug-pebble-db-analyze-data.md %}). Review the results with Cockroach
Labs Support
before changing the cluster setting

@rmloveland rmloveland requested a review from RaduBerinde May 4, 2026 17:18
@rmloveland
Copy link
Copy Markdown
Contributor Author

thanks for the review @RaduBerinde - i have updated to address your feedback, PTAL!

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.

2 participants