Package org.apache.flink.state.rocksdb

Enum RocksDBProperty

  • All Implemented Interfaces:
    Serializable, Comparable<RocksDBProperty>
    @Internal
public enum RocksDBProperty
extends Enum<RocksDBProperty>
    RocksDB properties that can be queried by Flink's metrics reporter.

    Note: Metrics properties are added in each new version of RocksDB, when upgrading to a latter version consider updating this class with newly added properties.

    • Method Detail

      • values

        public static RocksDBProperty[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (RocksDBProperty c : RocksDBProperty.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static RocksDBProperty valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getRocksDBProperty

        public String getRocksDBProperty()
        Returns:
        property string that can be used to query RocksDB.getLongProperty(ColumnFamilyHandle, String).

      • getNumericalPropertyValue

        public long getNumericalPropertyValue​(org.rocksdb.RocksDB rocksDB,
                                      org.rocksdb.ColumnFamilyHandle handle)
                               throws Exception
        Throws:
        Exception

      • getConfigKey

        public String getConfigKey()
        Returns:
        key for enabling metric using Configuration.