This is an automated email from the ASF dual-hosted git repository.
hangxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 8fba491c9c2 [FLINK-18255][state] Add API annotations to RocksDB
user-facing classes (#24496)
8fba491c9c2 is described below
commit 8fba491c9c2ebc447e7dc2215c03177360e7ec87
Author: Jinzhong Li <lijinzhong2...@gmail.com>
AuthorDate: Thu Mar 14 14:50:08 2024 +0800
[FLINK-18255][state] Add API annotations to RocksDB user-facing classes
(#24496)
---
.../contrib/streaming/state/ConfigurableRocksDBOptionsFactory.java | 2 ++
.../flink/contrib/streaming/state/RocksDBConfigurableOptions.java | 2 ++
.../flink/contrib/streaming/state/RocksDBNativeMetricOptions.java | 2 ++
.../java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java | 2 ++
.../apache/flink/contrib/streaming/state/RocksDBOptionsFactory.java | 3 +++
.../flink/contrib/streaming/state/RocksDBStateBackendFactory.java | 1 +
.../flink/contrib/streaming/state/iterator/SingleStateIterator.java | 3 +++
.../flink/contrib/streaming/state/restore/RocksDBRestoreOperation.java | 2 ++
8 files changed, 17 insertions(+)
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/ConfigurableRocksDBOptionsFactory.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/ConfigurableRocksDBOptionsFactory.java
index aaca0c4677d..a988d3f2a42 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/ConfigurableRocksDBOptionsFactory.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/ConfigurableRocksDBOptionsFactory.java
@@ -18,9 +18,11 @@
package org.apache.flink.contrib.streaming.state;
+import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.ReadableConfig;
/** An interface for options factory that pick up additional parameters from a
configuration. */
+@PublicEvolving
public interface ConfigurableRocksDBOptionsFactory extends
RocksDBOptionsFactory {
/**
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java
index 47e66f03295..19c424ed74f 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBConfigurableOptions.java
@@ -18,6 +18,7 @@
package org.apache.flink.contrib.streaming.state;
+import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.MemorySize;
import org.apache.flink.configuration.description.Description;
@@ -53,6 +54,7 @@ import static org.rocksdb.InfoLogLevel.INFO_LEVEL;
* PredefinedOptions}, and then a user-defined {@link RocksDBOptionsFactory}
may override the
* configurations here.
*/
+@PublicEvolving
public class RocksDBConfigurableOptions implements Serializable {
//
--------------------------------------------------------------------------
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBNativeMetricOptions.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBNativeMetricOptions.java
index 7975f5f059c..ad601242283 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBNativeMetricOptions.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBNativeMetricOptions.java
@@ -18,6 +18,7 @@
package org.apache.flink.contrib.streaming.state;
+import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.configuration.ConfigOption;
import org.apache.flink.configuration.ConfigOptions;
@@ -46,6 +47,7 @@ import java.util.Set;
*
href="https://github.com/facebook/rocksdb/blob/64324e329eb0a9b4e77241a425a1615ff524c7f1/include/rocksdb/db.h#L429";>
* db.h</a> for more information.
*/
+@PublicEvolving
public class RocksDBNativeMetricOptions implements Serializable {
private static final long serialVersionUID = 1L;
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java
index e78d9fb0eb5..e0fd2303939 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptions.java
@@ -18,6 +18,7 @@
package org.apache.flink.contrib.streaming.state;
+import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.configuration.ClusterOptions;
import org.apache.flink.configuration.ConfigOption;
@@ -33,6 +34,7 @@ import static
org.apache.flink.contrib.streaming.state.PredefinedOptions.SPINNIN
import static
org.apache.flink.contrib.streaming.state.PredefinedOptions.SPINNING_DISK_OPTIMIZED_HIGH_MEM;
/** Configuration options for the RocksDB backend. */
+@PublicEvolving
public class RocksDBOptions {
/** The local directory (on the TaskManager) where RocksDB puts its files.
*/
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptionsFactory.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptionsFactory.java
index 80f611a4f67..8eab2a91849 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptionsFactory.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBOptionsFactory.java
@@ -18,6 +18,8 @@
package org.apache.flink.contrib.streaming.state;
+import org.apache.flink.annotation.PublicEvolving;
+
import org.rocksdb.ColumnFamilyOptions;
import org.rocksdb.DBOptions;
import org.rocksdb.ReadOptions;
@@ -50,6 +52,7 @@ import java.util.Collection;
* });
* }</pre>
*/
+@PublicEvolving
public interface RocksDBOptionsFactory extends java.io.Serializable {
/**
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBStateBackendFactory.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBStateBackendFactory.java
index 14c240d86e4..35fc4425c54 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBStateBackendFactory.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/RocksDBStateBackendFactory.java
@@ -29,6 +29,7 @@ import java.io.IOException;
* A factory that creates an {@link
org.apache.flink.contrib.streaming.state.RocksDBStateBackend}
* from a configuration.
*/
+@Deprecated
public class RocksDBStateBackendFactory implements
StateBackendFactory<RocksDBStateBackend> {
@Override
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/iterator/SingleStateIterator.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/iterator/SingleStateIterator.java
index 0238279579d..1be45985c9f 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/iterator/SingleStateIterator.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/iterator/SingleStateIterator.java
@@ -18,9 +18,12 @@
package org.apache.flink.contrib.streaming.state.iterator;
+import org.apache.flink.annotation.Internal;
+
import java.io.Closeable;
/** An interface for iterating over a single state in a RocksDB state backend.
*/
+@Internal
public interface SingleStateIterator extends Closeable {
void next();
diff --git
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/restore/RocksDBRestoreOperation.java
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/restore/RocksDBRestoreOperation.java
index b70df737dd8..c43dbd7acd5 100644
---
a/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/restore/RocksDBRestoreOperation.java
+++
b/flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/restore/RocksDBRestoreOperation.java
@@ -18,9 +18,11 @@
package org.apache.flink.contrib.streaming.state.restore;
+import org.apache.flink.annotation.Internal;
import org.apache.flink.runtime.state.RestoreOperation;
/** Interface for RocksDB restore. */
+@Internal
public interface RocksDBRestoreOperation
extends RestoreOperation<RocksDBRestoreResult>, AutoCloseable {
/** Restores state that was previously snapshot-ed from the provided state
handles. */
