[hotfix][docs] clarify RocksDB thread options applicability per opera…

…tor/TM
deepfield · Nov 13, 2019 · f93d350 · f93d350
1 parent 79e3b32
commit f93d350
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/_includes/generated/rocks_db_configurable_configuration.html b/docs/_includes/generated/rocks_db_configurable_configuration.html
@@ -40,12 +40,12 @@
  <tr>
  <td><h5>state.backend.rocksdb.files.open</h5></td>
  <td style="word-wrap: break-word;">(none)</td>
- <td>The maximum number of open files that can be used by the DB, '-1' means no limit. RocksDB has default configuration as '5000'.</td>
+ <td>The maximum number of open files (per TaskManager) that can be used by the DB, '-1' means no limit. RocksDB has default configuration as '5000'.</td>
  </tr>
  <tr>
  <td><h5>state.backend.rocksdb.thread.num</h5></td>
  <td style="word-wrap: break-word;">(none)</td>
- <td>The maximum number of concurrent background flush and compaction jobs. RocksDB has default configuration as '1'.</td>
+ <td>The maximum number of concurrent background flush and compaction jobs (per TaskManager). RocksDB has default configuration as '1'.</td>
  </tr>
  <tr>
  <td><h5>state.backend.rocksdb.writebuffer.count</h5></td>

diff --git a/docs/_includes/generated/rocks_db_configuration.html b/docs/_includes/generated/rocks_db_configuration.html
@@ -10,7 +10,7 @@
  <tr>
  <td><h5>state.backend.rocksdb.checkpoint.transfer.thread.num</h5></td>
  <td style="word-wrap: break-word;">1</td>
- <td>The number of threads used to transfer (download and upload) files in RocksDBStateBackend.</td>
+ <td>The number of threads (per stateful operator) used to transfer (download and upload) files in RocksDBStateBackend.</td>
  </tr>
  <tr>
  <td><h5>state.backend.rocksdb.localdir</h5></td>

diff --git a/...db/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java b/...db/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java
@@ -46,13 +46,13 @@ public class RocksDBConfigurableOptions implements Serializable {
  public static final ConfigOption<String> MAX_BACKGROUND_THREADS =
  key("state.backend.rocksdb.thread.num")
  .noDefaultValue()
- .withDescription("The maximum number of concurrent background flush and compaction jobs. " +
+ .withDescription("The maximum number of concurrent background flush and compaction jobs (per TaskManager). " +
  "RocksDB has default configuration as '1'.");
 
  public static final ConfigOption<String> MAX_OPEN_FILES =
  key("state.backend.rocksdb.files.open")
  .noDefaultValue()
- .withDescription("The maximum number of open files that can be used by the DB, '-1' means no limit. " +
+ .withDescription("The maximum number of open files (per TaskManager) that can be used by the DB, '-1' means no limit. " +
  "RocksDB has default configuration as '5000'.");
 
  //--------------------------------------------------------------------------

diff --git a/...ackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java b/...ackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java
@@ -56,7 +56,7 @@ public class RocksDBOptions {
  public static final ConfigOption<Integer> CHECKPOINT_TRANSFER_THREAD_NUM = ConfigOptions
  .key("state.backend.rocksdb.checkpoint.transfer.thread.num")
  .defaultValue(1)
- .withDescription("The number of threads used to transfer (download and upload) files in RocksDBStateBackend.");
+ .withDescription("The number of threads (per stateful operator) used to transfer (download and upload) files in RocksDBStateBackend.");
 
  /** This determines if compaction filter to cleanup state with TTL is enabled. */
  public static final ConfigOption<Boolean> TTL_COMPACT_FILTER_ENABLED = ConfigOptions