Correct storage policy docs against source behavior#475
Open
glasstiger wants to merge 4 commits into
Open
Conversation
- SET STORAGE POLICY fully replaces the policy; omitted stages are cleared, not merged (docs claimed partial updates) - TO REMOTE is accepted and stored but not enforced, not rejected at parse time; only DROP REMOTE is rejected - storage_policies renders unset stages as 0h, not blank - Fix Enterprise TTL rejection message; CREATE TABLE ... TTL is translated to DROP LOCAL, not rejected - Config: check.interval 5m (was 15m), worker.count 4 (was 2); drop nonexistent writer.wait.timeout; document worker.* tuning props - SHOW CREATE TABLE does not render a disabled policy - meta.md: year TTLs are stored as months (1 YEAR -> 12m) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
🚀 Build success! Latest successful preview: https://preview-475--questdb-documentation.netlify.app/docs/ Commit SHA: 11bfa1b
|
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- meta.md: storage_policies.table_dir_name cross-reference now names the
real tables() column (directoryName, not table_dir_name)
- create-table.md: reorder syntax diagram so TTL/STORAGE POLICY precedes
WAL, matching every example and SHOW CREATE TABLE output
- alter-table-set-ttl.md: align framing with ttl.md ("superseded by
Storage Policy" instead of "deprecated")
- ttl.md: note materialized views still use TTL on Enterprise
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Address review findings on PR #475: three wording corrections consistent with the local-only behavior documented elsewhere in the PR. - configuration/storage-policy.md: intro no longer claims present-tense "cold storage offloading"; describes local Parquet conversion and drop. - concepts/storage-policy.md: the storage_policies view lists all policies and their status, not just active ones (it also returns disabled rows). - concepts/ttl.md: storage-policy cross-reference drops "offload to object storage" from the current lifecycle description. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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
Corrects the storage policy documentation against the actual QuestDB Enterprise
source behavior, from an audit of every storage-policy-related page.
Behavioral corrections
SET STORAGE POLICYfully replaces the policy. Omitted stages arecleared, not preserved. The parser resets every stage to
0and the writerappends a fresh row with no merge, so the previous "omitted settings remain
unchanged" wording was wrong.
TO REMOTEis accepted and stored, not rejected. It is parsed, validated,and persisted, but not yet enforced (no upload happens). Only
DROP REMOTEisrejected at parse time with
'DROP REMOTE' is not supported yet. The docspreviously claimed both were rejected with parse-time errors.
0hinstorage_policies, not blank.drop_remoteis always
0h;to_remoteis0hunless a value is set.TTL is not supported on Enterprise tables; use a storage policy instead, notTTL settings are deprecated, ...(which does not exist in the source).CREATE TABLE ... TTLis translated intoSTORAGE POLICY(DROP LOCAL ...),not rejected, in Enterprise. Only
ALTER TABLE SET TTLwith a non-zero valueis rejected.
SHOW CREATE TABLEdoes not render a disabled policy (the reader loadsactive-only policies).
Configuration corrections
storage.policy.check.intervaldefault is5m, not15m.storage.policy.worker.countdefault is4, not2.storage.policy.writer.wait.timeout, which does not exist in the source.worker.haltOnError,worker.nap.threshold,worker.sleep.threshold, andworker.yield.threshold.Other
meta.md: year-based TTLs are stored as months (1 YEARrenders as12m),not normalized to hours.
🤖 Generated with Claude Code