glide
ClusterScanCursor
Bases: ClusterScanCursor
ClusterScanCursor using the async package's FFI instance.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/_ffi_wrappers.py
19 20 21 22 23 | |
Script
Bases: Script
Script using the async package's FFI instance.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/_ffi_wrappers.py
12 13 14 15 16 | |
GlideClient
Bases: BaseClient, StandaloneCommands
Client used for connection to standalone servers.
Use :func:~BaseClient.create to request a client.
For full documentation, see
Valkey GLIDE Documentation
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/glide_client.py
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 | |
get_subscriptions()
async
Retrieves both the desired and current subscription states as tracked by the client.
This allows verification of synchronization between what the client intends to be subscribed to (desired) and what it is actually subscribed to on the server (actual).
Returns:
| Type | Description |
|---|---|
PubSubState
|
GlideClientConfiguration.PubSubState: An object containing two attributes: - desired_subscriptions: Dict[PubSubChannelModes, Set[str]] - actual_subscriptions: Dict[PubSubChannelModes, Set[str]] |
Examples:
>>> from glide import GlideClientConfiguration
>>> PubSubChannelModes = GlideClientConfiguration.PubSubChannelModes
>>>
>>> # Get both subscription states
>>> state = await client.get_subscriptions()
>>> desired = state.desired_subscriptions
>>> actual = state.actual_subscriptions
>>>
>>> # Check if subscribed to specific channel
>>> if "channel1" in actual.get(PubSubChannelModes.Exact, set()):
>>> print("Subscribed to channel1")
>>>
>>> # Check if synchronized
>>> if desired == actual:
>>> print("Subscriptions are synchronized")
>>>
>>> # Find missing subscriptions
>>> missing = desired.get(PubSubChannelModes.Exact, set()) - actual.get(PubSubChannelModes.Exact, set())
>>> if missing:
>>> print(f"Not yet subscribed to: {missing}")
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/glide_client.py
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 | |
GlideClusterClient
Bases: BaseClient, ClusterCommands
Client used for connection to cluster servers.
Use :func:~BaseClient.create to request a client.
For full documentation, see
Valkey GLIDE Documentation
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/glide_client.py
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 | |
get_subscriptions()
async
Retrieves both the desired and current subscription states as tracked by the client.
This allows verification of synchronization between what the client intends to be subscribed to (desired) and what it is actually subscribed to on the server (actual).
Returns:
| Type | Description |
|---|---|
PubSubState
|
GlideClusterClientConfiguration.PubSubState: An object containing two attributes: - desired_subscriptions: Dict[PubSubChannelModes, Set[str]] - actual_subscriptions: Dict[PubSubChannelModes, Set[str]] |
Examples:
>>> from glide import GlideClusterClientConfiguration
>>> PubSubChannelModes = GlideClusterClientConfiguration.PubSubChannelModes
>>>
>>> # Get both subscription states
>>> state = await client.get_subscriptions()
>>> desired = state.desired_subscriptions
>>> actual = state.actual_subscriptions
>>>
>>> # Check if subscribed to specific channel
>>> if "channel1" in actual.get(PubSubChannelModes.Exact, set()):
>>> print("Subscribed to channel1")
>>>
>>> # Check if synchronized
>>> if desired == actual:
>>> print("Subscriptions are synchronized")
>>>
>>> # Find missing subscriptions
>>> missing = desired.get(PubSubChannelModes.Exact, set()) - actual.get(PubSubChannelModes.Exact, set())
>>> if missing:
>>> print(f"Not yet subscribed to: {missing}")
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/glide_client.py
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 | |
MonitorClient
An async client that streams all commands processed by the server via MONITOR.
Must be used with a standalone (non-cluster) configuration.
The configuration's lib_name and client_info_tag identify the dedicated
monitor connection, using GlidePy as the default library name.
Supports both asyncio and trio backends via anyio.
Warning: MONITOR is a debugging tool with performance implications. Do not use in production environments.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | |
create(config, callback=None)
async
classmethod
Create a new async MonitorClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
GlideClientConfiguration
|
Standalone client configuration (must be GlideClientConfiguration). Its library-name override and client information tag are applied to the dedicated monitor connection. |
required |
callback
|
Optional[Callable[[MonitorMsg], None]]
|
Optional sync callback invoked for each MonitorMsg. If None, messages are queued for get_monitor_message(). |
None
|
Returns:
| Type | Description |
|---|---|
MonitorClient
|
A MonitorClient instance. |
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | |
get_monitor_message()
async
Wait for and return the next MonitorMsg.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
175 176 177 178 179 180 181 | |
try_get_monitor_message()
Non-blocking retrieval. Returns None if queue is empty.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
183 184 185 186 187 188 189 190 191 192 193 194 195 | |
stop()
async
Stop monitoring and release resources.
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
197 198 199 200 201 202 203 204 205 206 207 208 209 210 | |
aclose()
async
Alias for stop().
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/monitor_client.py
212 213 214 | |
OpenTelemetry
Bases: OpenTelemetry
Async client OpenTelemetry singleton (separate from sync).
Source code in doc-gen/valkey-glide/python/glide-async/python/glide/opentelemetry.py
11 12 13 14 15 | |