docs: document query.timeout duration key alongside query.timeout.sec - #483
Conversation
javier
left a comment
There was a problem hiding this comment.
I think we should add an entry for the query.timeout property right about query.timeout.sec, and explain in both sections which one has priority.
…recated Review feedback: document query.timeout as a property in its own right, right above query.timeout.sec, and state the precedence rule in both sections. query.timeout.sec is registered as deprecated in favour of query.timeout (PropServerConfiguration.java, registerDeprecated), so the note points readers at the replacement key.
|
Done, thanks for the review.
While writing it I noticed Happy to drop the deprecation note if you would rather keep that for a separate change. |
|
Thanks! publishing it now! |
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.