experimental-glide-core-lib 2.5.0

Core client library for Valkey GLIDE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

syntax = "proto3";
package connection_request;

message NodeAddress {
    string host = 1;
    uint32 port = 2;
}

enum ReadFrom {
    Primary = 0;
    PreferReplica = 1;
    LowestLatency = 2;
    AZAffinity = 3;
    AZAffinityReplicasAndPrimary = 4;
    AllNodes = 5;
}

enum TlsMode {
    NoTls = 0;
    SecureTls = 1;
    InsecureTls = 2;
}

message AuthenticationInfo {
    string password = 1;
    string username = 2;
    optional IamCredentials iam_credentials = 3;
}

enum ServiceType {
  ELASTICACHE = 0;
  MEMORYDB    = 1;
}

message IamCredentials {
    string cluster_name = 1;
    string region = 2;
    ServiceType service_type = 3;
    optional uint32 refresh_interval_seconds = 4;
}

enum ProtocolVersion {
    RESP3 = 0;
    RESP2 = 1;
}

message PeriodicChecksManualInterval {
    uint32 duration_in_sec = 1;
}

message PeriodicChecksDisabled {
}

enum PubSubChannelType {
    Exact = 0;
    Pattern = 1;
    Sharded = 2;
}

enum CompressionBackend {
    ZSTD = 0;
    LZ4 = 1;
}

// Controls how the client discovers node roles and topology in standalone mode.
enum NodeDiscoveryMode {
    Standard = 0;       // Default: verify node roles, use only provided addresses
    Static = 1;         // Skip role detection, trust provided addresses as-is.
                        // Suitable for proxies (e.g., Envoy) or known-static topologies.
                        // Note: Do not set client_name when using this mode with a proxy.
    DiscoverAll = 2;    // Discover full topology from any starting node
}

message CompressionConfig {
    bool enabled = 1;
    CompressionBackend backend = 2;
    optional int32 compression_level = 3;
    uint32 min_compression_size = 4;
    // Maximum allowed size for decompressed data to prevent decompression bombs.
    // If not set, defaults to 512MB (matching Valkey's proto-max-bulk-len).
    optional uint64 max_decompressed_size = 5;
}

message PubSubChannelsOrPatterns
{
    repeated bytes channels_or_patterns = 1;
}

message PubSubSubscriptions
{
    map<uint32, PubSubChannelsOrPatterns> channels_or_patterns_by_type = 1;
}

message ClientSideCache {
    string cache_id = 1;
    uint64 max_cache_kb = 2;
    uint64 entry_ttl_ms = 3; // 0 = no expiration
    optional EvictionPolicy eviction_policy = 4;
    bool enable_metrics = 5;
    bool server_assisted = 6;
}

enum EvictionPolicy {
    LRU = 0;
    LFU = 1;
}

// IMPORTANT - if you add fields here, you probably need to add them also in client/mod.rs:`sanitized_request_string`.
message ConnectionRequest {
    repeated NodeAddress addresses = 1;
    TlsMode tls_mode = 2;
    bool cluster_mode_enabled = 3;
    uint32 request_timeout = 4;
    ReadFrom read_from = 5;
    ConnectionRetryStrategy connection_retry_strategy = 6;
    AuthenticationInfo authentication_info = 7;
    uint32 database_id = 8;
    ProtocolVersion protocol = 9;
    string client_name = 10;
    oneof periodic_checks {
        PeriodicChecksManualInterval periodic_checks_manual_interval = 11;
        PeriodicChecksDisabled periodic_checks_disabled = 12;
    }
    PubSubSubscriptions pubsub_subscriptions = 13;
    uint32 inflight_requests_limit = 14;
    string client_az = 15;
    uint32 connection_timeout = 16;
    bool lazy_connect = 17;
    bool refresh_topology_from_initial_nodes = 18;
    string lib_name = 19;
    repeated bytes root_certs = 20;
    optional CompressionConfig compression_config = 21;
    bytes client_cert = 22;
    bytes client_key = 23;
    optional bool tcp_nodelay = 24;
    optional uint32 pubsub_reconciliation_interval_ms = 25;
    optional bool read_only = 26;
    optional ClientSideCache client_side_cache = 27;
    NodeDiscoveryMode node_discovery_mode = 28;
    optional string address_resolver_key = 29;
    optional ClientCircuitBreakerConfig client_circuit_breaker = 30;
}

message ClientCircuitBreakerConfig {
    uint32 window_size_ms = 1;          // Sliding window in milliseconds. Default: 10000
    float failure_rate_threshold = 2;   // Error rate (0.0-1.0) to trip. Default: 0.5
    uint32 min_errors = 3;              // Minimum errors before rate is evaluated. Default: 50
    uint32 open_timeout_ms = 4;         // Time in Open before probe, in ms. Default: 5000
    bool count_timeouts = 5;            // Whether timeouts count. Default: false
    uint32 consecutive_successes = 6;   // Probes needed before closing. Default: 3
}

message ConnectionRetryStrategy {
    uint32 number_of_retries = 1;
    uint32 factor = 2;
    uint32 exponent_base = 3;
    optional uint32 jitter_percent = 4;
}