fix: Update hash index docs for auto-enable behavior#1730
Merged
Conversation
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://132c0ca5.spiceai-org-website.pages.dev |
phillipleblanc
approved these changes
May 15, 2026
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.
Summary
spiceai/spiceai#10749 (Arrow primary key upserts) removed the explicit
hash_index: enabledparameter from the spicepod schema and changed Arrow acceleration to enable hash indexing automatically whenprimary_keyorindexesis configured. The runtime now logs a warning ifhash_indexis still set, but the docs atwebsite/docs/features/data-acceleration/hash-index.mdcontinued to instruct users to sethash_index: enabled— which produces a warning and has no effect.Changes
hash_index: enabledfrom both YAML examples, and listed the exact runtime activation conditions.hash_indexrow, and added a:::noteadmonition explaining the deprecation and recommending removal fromparams.hash_index: enabledto use primary_key" entry with the new "ignored" warning, plus an entry covering therefresh_mode: cachingexception that the new runtime logic enforces.vNext-only: the source change (spiceai/spiceai#10749) is only in
trunk/nightly.website/versioned_docs/version-1.11.x/features/data-acceleration/hash-index.mdwas deliberately left untouched because v1.11.x still requires the explicithash_index: enabledparameter.The related references in
arrow/index.md,arrow/deployment.md, andpartitioning.mdare intentionally out of scope for this PR — they'll be addressed in a follow-up. Keeping this PR scoped to the canonical hash-index page makes the review tractable.Reference
Verified against
spiceai/spiceaitrunk:crates/runtime/src/component/dataset/acceleration.rslines 357-365 — newis_hash_index_enabled()logiccrates/runtime/src/component/dataset/acceleration.rslines 437-441 — ignored-parameter warning textcrates/runtime/src/component/dataset/acceleration.rsline 745 —test_hash_index_param_is_ignoredunit test confirms the runtime behaviorTest plan
cd website && npm run buildpasses locally