engines/valkey_client library

This library provides a Valkey-compatible interface.

It allows users to use the client with familiar class names (e.g., ValkeyClient, ValkeyException). This is a wrapper around keyscope_client to provide a seamless developer experience (DX) for those migrating from Valkey or preferring Valkey terminology.

Typedefs

ValkeyClient = KeyscopeClient
Alias for KeyscopeClient. Use this for Standalone/Sentinel connections.
ValkeyClientException = KeyscopeClientException
Alias for KeyscopeClientException. Thrown on invalid API usage.
ValkeyClusterClient = KeyscopeClusterClient
Alias for KeyscopeClusterClient. Use this for Cluster connections.
ValkeyConnectionException = KeyscopeConnectionException
Alias for KeyscopeConnectionException. Thrown on network/socket errors.
ValkeyConnectionSettings = KeyscopeConnectionSettings
Alias for KeyscopeConnectionSettings.
ValkeyException = KeyscopeException
Alias for KeyscopeException. The base class for all exceptions.
ValkeyLogger = KeyscopeLogger
Alias for KeyscopeLogger.
ValkeyLogLevel = KeyscopeLogLevel
Alias for KeyscopeLogLevel.
ValkeyMessage = KeyscopeMessage
Alias for KeyscopeMessage. Represents a Pub/Sub message.
ValkeyParsingException = KeyscopeParsingException
Alias for KeyscopeParsingException. Thrown on protocol parsing errors.
ValkeyPool = KeyscopePool
Alias for KeyscopePool. Use this for connection pooling.
ValkeyServerException = KeyscopeServerException
Alias for KeyscopeServerException. Thrown when the server responds with an error.