Package org.rocksdb

Enum Class CompressionType

java.lang.Object
java.lang.Enum<CompressionType>
org.rocksdb.CompressionType
All Implemented Interfaces:
Serializable, Comparable<CompressionType>, Constable
public enum CompressionType extends Enum<CompressionType>
Enum CompressionType

DB contents are stored in a set of blocks, each of which holds a sequence of key,value pairs. Each block may be compressed before being stored in a file. The following enum describes which compression method (if any) is used to compress a block.

  • Enum Constant Details

    • NO_COMPRESSION

      public static final CompressionType NO_COMPRESSION

    • SNAPPY_COMPRESSION

      public static final CompressionType SNAPPY_COMPRESSION

    • ZLIB_COMPRESSION

      public static final CompressionType ZLIB_COMPRESSION

    • BZLIB2_COMPRESSION

      public static final CompressionType BZLIB2_COMPRESSION

    • LZ4_COMPRESSION

      public static final CompressionType LZ4_COMPRESSION

    • LZ4HC_COMPRESSION

      public static final CompressionType LZ4HC_COMPRESSION

    • XPRESS_COMPRESSION

      public static final CompressionType XPRESS_COMPRESSION

    • ZSTD_COMPRESSION

      public static final CompressionType ZSTD_COMPRESSION

    • DISABLE_COMPRESSION_OPTION

      public static final CompressionType DISABLE_COMPRESSION_OPTION

  • Method Details

    • values

      public static CompressionType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CompressionType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCompressionType

      public static CompressionType getCompressionType(String libraryName)

      Get the CompressionType enumeration value by passing the library name to this method.

      If library cannot be found the enumeration value NO_COMPRESSION will be returned.

      Parameters:
      libraryName - compression library name.
      Returns:
      CompressionType instance.

    • getCompressionType

      public static CompressionType getCompressionType(byte byteIdentifier)

      Get the CompressionType enumeration value by passing the byte identifier to this method.

      Parameters:
      byteIdentifier - of CompressionType.
      Returns:
      CompressionType instance.
      Throws:
      IllegalArgumentException - If CompressionType cannot be found for the provided byteIdentifier

    • getValue

      public byte getValue()

      Returns the byte value of the enumerations value.

      Returns:
      byte representation

    • getLibraryName

      public String getLibraryName()

      Returns the library name of the compression type identified by the enumeration value.

      Returns:
      library name