Add query.max-total-memory-per-task docs

trinodb · Jan 5, 2022 · ddf033d · ddf033d
1 parent 3fd1a9b
commit ddf033d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/src/main/sphinx/admin/properties-memory-management.rst b/docs/src/main/sphinx/admin/properties-memory-management.rst
@@ -56,6 +56,16 @@ system memory allocated by a query across all workers hits this limit it is
 killed. The value of ``query.max-total-memory`` must be greater than
 ``query.max-memory``.
 
+``query.max-total-memory-per-task``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* **Type:** :ref:`prop-type-data-size`
+* **Default value:** none, and therefore unrestricted
+* **Session property:** ``query_max_total_memory_per_task``
+
+This is the max amount of user and system memory a task can use on a node in the
+cluster. Support for using this property is experimental only.
+
 ``memory.heap-headroom-per-node``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^