questdb / questdb/documentation

multiple inconsistencies between the default configuration variables, their documentation and naming conventions

Open
#274 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
44
Avg merge
1d 9h
Merged PRs (30d)
26

Description

To reproduce

There are multiple inconsistencies between the default configuration variables, their documentation, and naming conventions in QuestDB (tested on version 9.0, but issues persist in later versions as well).
Reference: QuestDB Configuration Documentation

Issues

Query Timeout Variable
  • Documentation: Refers to query.timeout.sec
  • Default Config File: Uses query.timeout=1m
  • Actual Behavior: Based on testing, the correct and functional format is query.timeout.sec=60

⚠️ The documentation and default configuration are inconsistent, and the working format is not clearly documented.

Auto-Scaling Symbol Capacity
  • Documentation: Does not mention the variable cairo.auto.scale.symbol.capacity
  • Default Config File: Includes the following commented section:
## Flag to enable or disable symbol capacity auto-scaling. Auto-scaling means resizing
## symbol table data structures as the number of symbols in the table grows. Optimal sizing of
## these data structures ensures optimal ingress performance.
##
## By default, the auto-scaling is enabled. This is optimal. You may want to disable auto-scaling in case
## something goes wrong.
##
## Database restart is NOT required when this setting is changed
#cairo.auto.scale.symbol.capacity=false

⚠️ The comment claims that auto-scaling is enabled by default, but the provided line defaults to false, which contradicts that statement.

Missing Variable in Default Config
  • Documentation: Mentions line.tcp.auth.db.path
  • Default Config File: Does not contain this variable at all

⚠️ The documentation references a configuration option that isn’t present in the default config file.

To sum up, configuration variables, defaults, and documentation should be consistent and reflect actual working values and formats. Also the documentation should clarify correct naming and default states.

QuestDB version:

9.0

OS, in case of Docker specify Docker and the Host OS:

Amazon Linux 2023.6.20250317

File System, in case of Docker specify Host File System:

xfs

Full Name:

Rino Pauletto

Affiliation:

Rebernig Supervisioni (rebernig.it)

Have you followed Linux, MacOs kernel configuration steps to increase Maximum open files and Maximum virtual memory areas limit?
  • Yes, I have
Additional context

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the linked QuestDB Configuration Documentation with the default configuration file, focusing on query.timeout.sec, cairo.auto.scale.symbol.capacity, and line.tcp.auth.db.path. Verify the working query timeout format and the auto-scaling default on QuestDB 9.0. Done means the documented names, defaults, formats, and default-config comments agree.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.