Skip to content

Apache DataFusion SQL Query Engine

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

Eren Avsarogullaria1148409bffe
diff --git a/docs/source/user-guide/cli/usage.md b/docs/source/user-guide/cli/usage.md
index 68804b2817..7c56b994fc 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 <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')