docs(cayenne): document cayenne_metastore_* runtime.params tuning knobs#1933
Open
claudespice wants to merge 1 commit into
Open
docs(cayenne): document cayenne_metastore_* runtime.params tuning knobs#1933claudespice wants to merge 1 commit into
claudespice wants to merge 1 commit into
Conversation
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://46ee885d.spiceai-org-website.pages.dev |
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
The Cayenne
runtime.paramsreference omits the entirecayenne_metastore_*sub-family — SQLite-metastore tuning knobs that the runtime reads fromruntime.paramsat startup (crates/runtime/src/builder.rs) but that appear nowhere in the docs. This documents them, scoped per version (the family and its defaults differ across releases; verified against each tag).These apply to the default
sqlitemetastore backend (already documented viacayenne_metastore); thetursobackend uses MVCC and ignores them.vNext + version-2.1.x (identical — 6 params):
cayenne_metastore_cache_mb256cayenne_metastore_mmap_mb1024(1 GiB)cayenne_metastore_busy_timeout_ms30000cayenne_metastore_wal_autocheckpoint_pages0(inline auto-checkpoint disabled; WAL drained by background checkpoint)cayenne_metastore_wal_truncate_threshold_mb160cayenne_metastore_auto_vacuumnone(none|incremental|full)version-2.0.x (5 params): no
cayenne_metastore_wal_truncate_threshold_mb(the background-truncate mechanism landed after v2.0), andcayenne_metastore_wal_autocheckpoint_pagesdefaults to10000in v2.0, not0. Both differences verified against the v2.0.1 source, so the 2.0.x snapshot documents the 2.0 values, not the trunk values.Not documented for v1.x — the
cayenne_metastore_*params do not exist there (absent from v1.11.0builder.rs).Source (per version)
spiceai/spiceai@trunk/v2.1.0:crates/runtime/src/builder.rs— reads all 6 keys fromruntime.paramscrates/cayenne/src/metastore/sqlite.rsimpl Default for SqliteMetastoreConfig—cache_size_mb: 256,mmap_size_bytes: 1 GiB,busy_timeout_ms: 30_000,wal_autocheckpoint_pages: 0,wal_truncate_threshold_bytes: 160 MiB,auto_vacuum: Nonespiceai/spiceai@v2.0.1:crates/runtime/src/builder.rs:273-295— reads 5 keys (nowal_truncate_threshold_mb)crates/cayenne/src/metastore/sqlite.rsdefault —wal_autocheckpoint_pages: 10_000, nowal_truncate_threshold_bytesfieldTest plan
cd website && npm run buildpasses