Repository navigation
docs(caching): xxh32 hashing_algorithm is deprecated - #2449
Merged
Merged
Conversation
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
There was a problem hiding this comment.
🟢 Approved
No active review issues remain for the documentation-only update clarifying xxh32 deprecation and migration to xxh3.
No open issues 🎉
What changed in this PR
This documentation-only PR updates the caching feature guide and runtime reference to mark hashing_algorithm: xxh32 as deprecated and direct users to xxh3.
Changes:
- Removes
xxh32from the supported-choice lists in both configuration tables. - Adds dedicated
xxh32entries describing the startup warning, planned removal, and recommended replacement.
| File | Description |
|---|---|
website/docs/reference/spicepod/runtime.md |
Updates the runtime caching reference with xxh32 deprecation guidance. |
website/docs/features/caching/index.md |
Adds matching deprecation and migration guidance to the caching feature guide. |
Review effort: Balanced
Contributor
|
🚀 deployed to https://e919d45d.spiceai-org-website.pages.dev |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHAT
The caching docs mark
hashing_algorithm: xxh32as deprecated, as spiceai/spiceai#15745 does. A runtime that sets it logs a warning at startup. The option will be removed in spiceai/spiceai#15725.WHY
The docs still list
xxh32as a supported choice, with no deprecation.HOW
The
hashing_algorithmrows on the caching feature page and theruntimespicepod reference no longer listxxh32as supported, and each page's algorithm list has its ownxxh32entry: deprecated, usexxh3.