Skip to content

Commit a114840

Browse files
docs: Update datafusion-cli doc for top-memory-consumers config (apache#20390)
## Which issue does this PR close? - Closes apache#20389. ## Rationale for this change If both `--memory-limit` or `--mem-pool-type` configs are not set in `datafusion-cli` command, `unbounded` memory pool is being used and so `unbounded` memory pool is not tracked pool so `--top-memory-consumers > 0` is valid as long as one of the runtime configs: memory_limit or memory_pool is set by using `greedy` or `fair` memory pool (which can be tracked by `TrackConsumersPool`) so this doc can be useful for the end-user to use either `greedy` or `fair` memory pool when `--top-memory-consumers > 0 `. ## What changes are included in this PR? Updating `datafusion-cli` doc for `top-memory-consumers` config. ## Are these changes tested? N/A due to updating the `datafusion-cli` doc. ## Are there any user-facing changes? Yes, updating `datafusion-cli` doc. Co-authored-by: Jonah Gao <jonahgao@msn.com>
1 parent 3b028fe commit a114840

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/source/user-guide/cli/usage.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ OPTIONS:
5858
Specify the memory pool type 'greedy' or 'fair', default to 'greedy'
5959

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

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

0 commit comments

Comments
 (0)