docs: add Lua script preloading documentation for kvrocks#511
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: add Lua script preloading documentation for kvrocks#511github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Add 'Lua scripts' section to docs/07-storage-kvrocks.md explaining script preloading, fallback mechanisms, and kvrocks compatibility - Add 'Startup' section to docs/10-operations.md documenting script preloading during API initialization - Add troubleshooting sections to docs/28-troubleshooting.md: - Section 1: 'preload repository scripts' startup errors - Section 2: NOSCRIPT error troubleshooting and fallback behavior - Renumber subsequent sections (3-12) These changes document PR #510 (fix/kvrocks-noscript-and-install-bundle) which preloads Lua scripts at startup to ensure kvrocks compatibility and includes automatic fallback to EVAL if scripts are not found. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced May 14, 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.
Documentation Update
This PR adds comprehensive documentation for the Lua script preloading feature introduced in PR #510 (fix/kvrocks-noscript-and-install-bundle).
Changes
1. docs/07-storage-kvrocks.md - Added "Lua scripts" section
claimMoveScriptandtokenBucketScriptPreloadScripts()at startup2. docs/10-operations.md - Added "Startup" section
3. docs/28-troubleshooting.md - Added 2 new troubleshooting sections
All subsequent troubleshooting sections have been renumbered accordingly (now 3-12).
Rationale
The Lua script preloading feature is critical for kvrocks compatibility. codeQ uses Lua scripts for atomic operations in hot paths (task claiming, rate limiting). kvrocks returns NOSCRIPT errors in a different format than standard Redis, so preloading ensures scripts are cached at startup. The automatic fallback to EVAL provides transparent error recovery if scripts are evicted from memory.
This documentation:
Quality Assurance