Compressing Data
Valkey GLIDE supports compressing string values, reducing memory usage and network bandwidth. When enabled, values are transparently compressed before being sent to the server and decompressed on retrieval.
import glide.api.GlideClient;import glide.api.models.configuration.*;
CompressionConfiguration compression = CompressionConfiguration.builder() .enabled(true) .backend(CompressionBackend.ZSTD) .compressionLevel(3) .minCompressionSize(128) .build();
GlideClientConfiguration config = GlideClientConfiguration.builder() .address(NodeAddress.builder().host("localhost").port(6379).build()) .compressionConfiguration(compression) .build();
GlideClient client = GlideClient.createClient(config).get();from glide import ( GlideClient, GlideClientConfiguration, CompressionConfiguration, CompressionBackend, NodeAddress,)
compression = CompressionConfiguration( enabled=True, backend=CompressionBackend.ZSTD, compression_level=3, min_compression_size=128,)
config = GlideClientConfiguration( addresses=[NodeAddress("localhost", 6379)], compression=compression,)client = await GlideClient.create(config)import { GlideClient, CompressionBackend } from "@valkey/valkey-glide";
const client = await GlideClient.createClient({ addresses: [{ host: "localhost", port: 6379 }], compression: { enabled: true, backend: CompressionBackend.ZSTD, compressionLevel: 3, minCompressionSize: 128, },});import ( "github.com/valkey-io/valkey-glide/go/v2/config" glide "github.com/valkey-io/valkey-glide/go/v2")
compression := config.NewCompressionConfiguration(). WithBackend(config.ZSTD). WithCompressionLevel(3). WithMinCompressionSize(128)
clientConfig := config.NewClientConfiguration(). WithAddress(&config.NodeAddress{Host: "localhost", Port: 6379}). WithCompressionConfiguration(compression)
client, err := glide.NewClient(clientConfig)$client = new ValkeyGlide();$client->connect( addresses: [['host' => 'localhost', 'port' => 6379]], compression: [ 'enabled' => true, 'backend' => ValkeyGlide::COMPRESSION_BACKEND_ZSTD, 'compression_level' => 3, 'min_compression_size' => 128, ],);using Valkey.Glide;using static Valkey.Glide.ConnectionConfiguration;
var compression = CompressionConfig.Zstd( compressionLevel: 3, minCompressionSize: 128);
var config = new StandaloneClientConfigurationBuilder() .WithAddress("localhost", 6379) .WithCompression(compression) .Build();
await using var client = await GlideClient.CreateClient(config);When to use compression
Section titled “When to use compression”Compression works well when you primarily use basic read and write commands with large string values. If your application uses commands that read, modify, or compare a stored string, don’t use compression.
See Compatibilityf or the full list of supported and incompatible commands.
Configuration options
Section titled “Configuration options”| Option | Default | Description |
|---|---|---|
enabled | false | Toggle compression on/off |
backend | ZSTD | Compression algorithm: ZSTD or LZ4 |
compressionLevel | Backend default (ZSTD=3, LZ4=0) | Compression level; valid ranges are backend-specific |
minCompressionSize | 64 bytes | Values below this threshold are not compressed (minimum: 6 bytes) |
maxDecompressedSize | 512 MB | Maximum decompressed size; protects against decompression bombs |
Learn more
Section titled “Learn more”To understand how compression works under the hood, see our section on Data Compression.