You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ga...@apache.org on 2020/01/24 17:36:13 UTC
[flink] branch release-1.10 updated: [FLINK-15754][docs] Remove
config options table.exec.resource.*memory from docs
This is an automated email from the ASF dual-hosted git repository.
gary pushed a commit to branch release-1.10
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.10 by this push:
new a755c7e [FLINK-15754][docs] Remove config options table.exec.resource.*memory from docs
a755c7e is described below
commit a755c7e7dcd1253a3070735520d0d5873122d242
Author: Gary Yao <ga...@apache.org>
AuthorDate: Fri Jan 24 16:35:00 2020 +0100
[FLINK-15754][docs] Remove config options table.exec.resource.*memory from docs
---
.../generated/execution_config_configuration.html | 24 ----------------------
.../table/api/config/ExecutionConfigOptions.java | 12 +++++++----
2 files changed, 8 insertions(+), 28 deletions(-)
diff --git a/docs/_includes/generated/execution_config_configuration.html b/docs/_includes/generated/execution_config_configuration.html
index de9ca73..8004322 100644
--- a/docs/_includes/generated/execution_config_configuration.html
+++ b/docs/_includes/generated/execution_config_configuration.html
@@ -53,30 +53,6 @@ By default no operator is disabled.</td>
<td>Sets default parallelism for all operators (such as aggregate, join, filter) to run with parallel instances. This config has a higher priority than parallelism of StreamExecutionEnvironment (actually, this config overrides the parallelism of StreamExecutionEnvironment). A value of -1 indicates that no default parallelism is set, then it will fallback to use the parallelism of StreamExecutionEnvironment.</td>
</tr>
<tr>
- <td><h5>table.exec.resource.external-buffer-memory</h5><br> <span class="label label-primary">Batch</span></td>
- <td style="word-wrap: break-word;">"10 mb"</td>
- <td>String</td>
- <td>Sets the external buffer memory size that is used in sort merge join and nested join and over window. Note: memory size is only a weight hint, it will affect the weight of memory that can be applied by a single operator in the task, the actual memory used depends on the running environment.</td>
- </tr>
- <tr>
- <td><h5>table.exec.resource.hash-agg.memory</h5><br> <span class="label label-primary">Batch</span></td>
- <td style="word-wrap: break-word;">"128 mb"</td>
- <td>String</td>
- <td>Sets the managed memory size of hash aggregate operator. Note: memory size is only a weight hint, it will affect the weight of memory that can be applied by a single operator in the task, the actual memory used depends on the running environment.</td>
- </tr>
- <tr>
- <td><h5>table.exec.resource.hash-join.memory</h5><br> <span class="label label-primary">Batch</span></td>
- <td style="word-wrap: break-word;">"128 mb"</td>
- <td>String</td>
- <td>Sets the managed memory for hash join operator. It defines the lower limit. Note: memory size is only a weight hint, it will affect the weight of memory that can be applied by a single operator in the task, the actual memory used depends on the running environment.</td>
- </tr>
- <tr>
- <td><h5>table.exec.resource.sort.memory</h5><br> <span class="label label-primary">Batch</span></td>
- <td style="word-wrap: break-word;">"128 mb"</td>
- <td>String</td>
- <td>Sets the managed buffer memory size for sort operator. Note: memory size is only a weight hint, it will affect the weight of memory that can be applied by a single operator in the task, the actual memory used depends on the running environment.</td>
- </tr>
- <tr>
<td><h5>table.exec.shuffle-mode</h5><br> <span class="label label-primary">Batch</span></td>
<td style="word-wrap: break-word;">"batch"</td>
<td>String</td>
diff --git a/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/config/ExecutionConfigOptions.java b/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/config/ExecutionConfigOptions.java
index 20cc2ac..e9f595f 100644
--- a/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/config/ExecutionConfigOptions.java
+++ b/flink-table/flink-table-api-java/src/main/java/org/apache/flink/table/api/config/ExecutionConfigOptions.java
@@ -100,7 +100,8 @@ public class ExecutionConfigOptions {
"default parallelism is set, then it will fallback to use the parallelism " +
"of StreamExecutionEnvironment.");
- @Documentation.TableOption(execMode = Documentation.ExecMode.BATCH)
+ @Documentation.ExcludeFromDocumentation("Beginning from Flink 1.10, this is interpreted as a weight hint " +
+ "instead of an absolute memory requirement. Users should not need to change these carefully tuned weight hints.")
public static final ConfigOption<String> TABLE_EXEC_RESOURCE_EXTERNAL_BUFFER_MEMORY =
key("table.exec.resource.external-buffer-memory")
.defaultValue("10 mb")
@@ -109,7 +110,8 @@ public class ExecutionConfigOptions {
" it will affect the weight of memory that can be applied by a single operator" +
" in the task, the actual memory used depends on the running environment.");
- @Documentation.TableOption(execMode = Documentation.ExecMode.BATCH)
+ @Documentation.ExcludeFromDocumentation("Beginning from Flink 1.10, this is interpreted as a weight hint " +
+ "instead of an absolute memory requirement. Users should not need to change these carefully tuned weight hints.")
public static final ConfigOption<String> TABLE_EXEC_RESOURCE_HASH_AGG_MEMORY =
key("table.exec.resource.hash-agg.memory")
.defaultValue("128 mb")
@@ -118,7 +120,8 @@ public class ExecutionConfigOptions {
" that can be applied by a single operator in the task, the actual memory used" +
" depends on the running environment.");
- @Documentation.TableOption(execMode = Documentation.ExecMode.BATCH)
+ @Documentation.ExcludeFromDocumentation("Beginning from Flink 1.10, this is interpreted as a weight hint " +
+ "instead of an absolute memory requirement. Users should not need to change these carefully tuned weight hints.")
public static final ConfigOption<String> TABLE_EXEC_RESOURCE_HASH_JOIN_MEMORY =
key("table.exec.resource.hash-join.memory")
.defaultValue("128 mb")
@@ -127,7 +130,8 @@ public class ExecutionConfigOptions {
" memory that can be applied by a single operator in the task, the actual" +
" memory used depends on the running environment.");
- @Documentation.TableOption(execMode = Documentation.ExecMode.BATCH)
+ @Documentation.ExcludeFromDocumentation("Beginning from Flink 1.10, this is interpreted as a weight hint " +
+ "instead of an absolute memory requirement. Users should not need to change these carefully tuned weight hints.")
public static final ConfigOption<String> TABLE_EXEC_RESOURCE_SORT_MEMORY =
key("table.exec.resource.sort.memory")
.defaultValue("128 mb")