docs: document query.timeout duration key alongside query.timeout.sec#483
Open
PedroHenrique0713 wants to merge 1 commit into
Open
Conversation
1 task
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
Documents the
query.timeoutconfiguration key on the Cairo engine reference page, next to the existingquery.timeout.sec, and clarifies how the two relate.Why
Part of #274, which reports the query timeout configuration as inconsistent. The root cause is a documentation gap: both keys are valid and related, but no page explains that.
From the source (
PropServerConfiguration.java):query.timeout.sec— a number of seconds (default60)query.timeout— a duration parsed byNumbers.parseMillis(e.g.120s,1m,500ms) that overridesquery.timeout.secwhen setToday the reference page (
configuration/cairo-engine.md) only listsquery.timeout.sec, while the configuration overview example usesquery.timeout=120s. Neither mentions the other, which is what makes the two look inconsistent. This change makes the reference document both keys so the pages agree.Scope
This addresses the
query.timeoutpoint of #274 only. The other two points look out of scope for this docs repo:cairo.auto.scale.symbol.capacity— its default changed in feat(sql): enable symbol capacity auto-scaling by default questdb#6352, so it is better covered by the broader config refresh mentioned in the issue thread.line.tcp.auth.db.path— already documented inconfiguration/ingestion.md; the "missing from the default config" note is about the generatedserver.conftemplate in the core repo, not these docs.Testing
Docs-only prose change with no new links or components, so the Docusaurus broken-link build covers it.