You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by nk...@apache.org on 2019/11/13 14:18:20 UTC

[flink] 02/02: [hotfix][docs] clarify that a RocksDB dependency in pom.xml may not be needed

This is an automated email from the ASF dual-hosted git repository.

nkruber pushed a commit to branch release-1.8
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 48f2d6314d2ba3f3bad4b0a043fd3d8b699e9778
Author: Nico Kruber <ni...@ververica.com>
AuthorDate: Tue Nov 12 15:09:52 2019 +0100

    [hotfix][docs] clarify that a RocksDB dependency in pom.xml may not be needed
---
 docs/ops/state/state_backends.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/ops/state/state_backends.md b/docs/ops/state/state_backends.md
index c167803..cd0a041 100644
--- a/docs/ops/state/state_backends.md
+++ b/docs/ops/state/state_backends.md
@@ -146,16 +146,21 @@ env.setStateBackend(new FsStateBackend("hdfs://namenode:40010/flink/checkpoints"
 </div>
 </div>
 
-If you want to use the `RocksDBStateBackend`, then you have to add the following dependency to your Flink project.
+If you want to use the `RocksDBStateBackend` in your IDE or configure it programmatically in your Flink job, you will have to add the following dependency to your Flink project.
 
 {% highlight xml %}
 <dependency>
     <groupId>org.apache.flink</groupId>
     <artifactId>flink-statebackend-rocksdb{{ site.scala_version_suffix }}</artifactId>
     <version>{{ site.version }}</version>
+    <scope>provided</scope>
 </dependency>
 {% endhighlight %}
 
+<div class="alert alert-info" markdown="span">
+  <strong>Note:</strong> Since RocksDB is part of the default Flink distribution, you do not need this dependency if you are not using any RocksDB code in your job and configure the state backend via `state.backend` and further [checkpointing]({{ site.baseurl }}/ops/config.html#checkpointing) and [RocksDB-specific]({{ site.baseurl }}/ops/config.html#rocksdb-state-backend) parameters in your `flink-conf.yaml`.
+</div>
+
 
 ### Setting Default State Backend