From caa52afc5adff00130c8374ae2ad697231443912 Mon Sep 17 00:00:00 2001 From: Eren Avsarogullari Date: Mon, 16 Feb 2026 14:50:36 -0800 Subject: [PATCH] Update datafusion-cli doc for top-memory-consumers config --- docs/source/user-guide/cli/usage.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/user-guide/cli/usage.md b/docs/source/user-guide/cli/usage.md index 68804b2817e74..7c56b994fcc33 100644 --- a/docs/source/user-guide/cli/usage.md +++ b/docs/source/user-guide/cli/usage.md @@ -58,7 +58,9 @@ OPTIONS: Specify the memory pool type 'greedy' or 'fair', default to 'greedy' --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 Available disk space for spilling queries (e.g. '10g'), default to None (uses DataFusion's default value of '100g')