Skip to content

docs: Update datafusion-cli doc for top-memory-consumers config #20390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonahgao merged 2 commits into from
Mar 4, 2026
Merged

docs: Update datafusion-cli doc for top-memory-consumers config #20390

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
caa52af
Update datafusion-cli doc for top-memory-consumers config
erenavsarogullari Feb 16, 2026
5c25fc0
Merge branch 'main' into update_datafusion_cli_doc
jonahgao Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/user-guide/cli/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ OPTIONS:
Specify the memory pool type 'greedy' or 'fair', default to 'greedy'

--top-memory-consumers <TOP_MEMORY_CONSUMERS>
The number of top memory consumers to display when query fails due to memory exhaustion. To disable memory consumer tracking, set this value to 0 [default: 3]
The number of top memory consumers to display when query fails due to memory exhaustion.
To disable memory consumer tracking, set this value to 0 [default: 3].
Please set one of the runtime configs: '--memory-limit' or '--mem-pool-type' to see 'top-memory-consumers' result when memory is exhausted.

-d, --disk-limit <DISK_LIMIT>
Available disk space for spilling queries (e.g. '10g'), default to None (uses DataFusion's default value of '100g')
Expand Down