org.gridgain.grid.cache.compress

Class ZstdDictionaryCompressionConfiguration

java.lang.Object

org.gridgain.grid.cache.compress.ZstdDictionaryCompressionConfiguration

All Implemented Interfaces:

Serializable, EntryCompressionConfiguration, org.apache.ignite.internal.processors.cache.compress.EntryCompressionStrategySupplier, Extension

public class ZstdDictionaryCompressionConfiguration
extends Object
implements EntryCompressionConfiguration, org.apache.ignite.internal.processors.cache.compress.EntryCompressionStrategySupplier

Enables Zstandard-based compression with dictionary training and rotation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMPRESSION_LEVEL Default compression level, as per Zstandard library.
static int	DEFAULT_DICTIONARY_SIZE Default dictionary size, bytes.
static int	DEFAULT_SAMPLES_BUFFER_SIZE Default samples buffer size, bytes.

Constructor Summary

Constructors

Constructor and Description
ZstdDictionaryCompressionConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getCompressionLevel() Returns compression level, as per Zstandard library.
int	getDictionarySize() Returns dictionary size, in bytes.
int	getSamplesBufferSize() Returns size of the buffer that should hold samples collected for dictionary training.
boolean	isCompressKeys() Gets flag indicating whether cache keys will be considered for compression.
boolean	isRequireDictionary() Flag indicating that compression without dictionary, such as before the dictionary is trained, is enabled.
ZstdDictionaryCompressionConfiguration	setCompressionLevel(int compressionLevel) Sets compression level to be used by Zstandard library.
ZstdDictionaryCompressionConfiguration	setCompressKeys(boolean compressKeys) Sets flag indicating whether cache keys will be considered for compression.
ZstdDictionaryCompressionConfiguration	setDictionarySize(int dictionarySize) Sets dictionary size, in bytes.
ZstdDictionaryCompressionConfiguration	setRequireDictionary(boolean requireDictionary) Sets flag that enables compression without dictionary.
ZstdDictionaryCompressionConfiguration	setSamplesBufferSize(int samplesBufferSize) Returns size of the buffer that should hold samples collected for dictionary training.
Map<Class<ZstdDictionaryCompressionConfiguration>,IgniteClosure<ZstdDictionaryCompressionConfiguration,org.apache.ignite.internal.processors.cache.compress.EntryCompressionStrategy>>	strategies() Getting cache entry compression strategies.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COMPRESSION_LEVEL

public static final int DEFAULT_COMPRESSION_LEVEL

Default compression level, as per Zstandard library.

See Also:

Constant Field Values

DEFAULT_DICTIONARY_SIZE

public static final int DEFAULT_DICTIONARY_SIZE

Default dictionary size, bytes.

See Also:

Constant Field Values

DEFAULT_SAMPLES_BUFFER_SIZE

public static final int DEFAULT_SAMPLES_BUFFER_SIZE

Default samples buffer size, bytes.

See Also:

Constant Field Values

Constructor Detail

ZstdDictionaryCompressionConfiguration

public ZstdDictionaryCompressionConfiguration()

Method Detail

strategies

public Map<Class<ZstdDictionaryCompressionConfiguration>,IgniteClosure<ZstdDictionaryCompressionConfiguration,org.apache.ignite.internal.processors.cache.compress.EntryCompressionStrategy>> strategies()

Getting cache entry compression strategies.

Specified by:

strategies in interface org.apache.ignite.internal.processors.cache.compress.EntryCompressionStrategySupplier

Returns:

Cache entry compression strategies.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getCompressionLevel

public int getCompressionLevel()

Returns compression level, as per Zstandard library.

Returns:

Compression level.

setCompressionLevel

public ZstdDictionaryCompressionConfiguration setCompressionLevel(int compressionLevel)

Sets compression level to be used by Zstandard library.

Parameters:

compressionLevel - Compression level.

Returns:

this for chaining.

See Also:

ZstdCompressCtx.setLevel(int)

getDictionarySize

public int getDictionarySize()

Returns dictionary size, in bytes.

Returns:

Dictionary size, bytes.

setDictionarySize

public ZstdDictionaryCompressionConfiguration setDictionarySize(int dictionarySize)

Sets dictionary size, in bytes. Zstd will train a dictionary out of set of samples, then reuse dictionary to compress and decompress data. Larger dictionary results in better compression at cost of performance. A range of 0 to 16384 is recommended, with the default of {code 1024}. Values of 256 or smaller may prevent dictionary from training successfully. Setting dictionary size to zero will result in compression without dictionary, if it is enabled explicitly.

Parameters:

dictionarySize - Dictionary size, bytes.

Returns:

this for chaining.

See Also:

setRequireDictionary(boolean)

isRequireDictionary

public boolean isRequireDictionary()

Flag indicating that compression without dictionary, such as before the dictionary is trained, is enabled.

Returns:

If true, compression without dictionary is enabled.

setRequireDictionary

public ZstdDictionaryCompressionConfiguration setRequireDictionary(boolean requireDictionary)

Sets flag that enables compression without dictionary. Entries will be tried for compression without dictionary if this flag is set, and dictionary is either not trained yet or dictionary size set to 0. Needs to be true if dictionary size is set to 0.

Parameters:

requireDictionary - Flag value.

Returns:

this for chaining.

See Also:

setDictionarySize(int)

getSamplesBufferSize

public int getSamplesBufferSize()

Returns size of the buffer that should hold samples collected for dictionary training.

Returns:

Samples buffer size, in bytes.

setSamplesBufferSize

public ZstdDictionaryCompressionConfiguration setSamplesBufferSize(int samplesBufferSize)

Returns size of the buffer that should hold samples collected for dictionary training. As soon as this buffer is full, or samples count is reached, dictionary training will be triggered. More samples may be collected after first dictionary is trained for the needs of dictionary recycling, but not more than buffer size.

Parameters:

samplesBufferSize - Samples buffer size, in bytes.

Returns:

this for chaining.

See Also:

setDictionarySize(int)

isCompressKeys

public boolean isCompressKeys()

Gets flag indicating whether cache keys will be considered for compression.

Returns:

True if cache keys may be compressed.

setCompressKeys

public ZstdDictionaryCompressionConfiguration setCompressKeys(boolean compressKeys)

Sets flag indicating whether cache keys will be considered for compression.

Parameters:

compressKeys - true if cache keys may be compressed.

Returns:

this for chaining.