cRedisClient - Redis Client

Overview

cRedisClient is a simple and easy-to-use Redis database client written in VB6/VBA. It supports the Redis RESP protocol and provides common Redis command interfaces, including connection management, basic operations, data structure operations, and transactions.

Features

• Supports basic Redis commands (GET, SET, DEL, EXISTS, KEYS, etc.)
• Supports multiple data structures: String, Hash, List, Set, Sorted Set
• Supports pipeline mode
• Supports transaction mode
• Automatic reconnection mechanism (enabled by default)
• Built-in heartbeat keep-alive
• Supports Redis password authentication and ACL authentication (Redis 6.0+)
• Supports multiple database switching
• Synchronous operations, simple and easy to use

Documentation

• Connection Management - Connect and disconnect from Redis server
• Basic Commands - Authentication, database selection, information query, etc.
• String Operations - Key-value operations
• Hash Operations - Hash table operations
• List Operations - List operations
• Set Operations - Set operations
• Sorted Set Operations - Sorted set operations
• Transaction Operations - Transaction management
• Complete Examples - Comprehensive usage examples
• Unit Testing - Test cases and coverage

Properties

Property	Type	Description
Host	String	Get Redis server address
Port	Long	Get Redis server port
Connected	Boolean	Get connection status (internal flag)
IsConnected	Boolean	Get actual Socket connection status
Username	String	Get ACL authentication username
DbIndex	Long	Get or set current database index (0-15)
Timeout	Double	Get or set timeout in seconds
AutoReconnect	Boolean	Get or set auto-reconnect (default True)
HeartbeatInterval	Long	Get or set heartbeat interval in seconds (default 30)
InTransaction	Boolean	Get if in transaction
InPipeline	Boolean	Get if in pipeline mode
LastError	String	Get last error message
Socket	cWinsock	Get underlying Socket object

Notes

1. Connection Management: Remember to call DisConnect method to release connection when done
2. Error Handling: Check connection status and LastError property before and after operations
3. Timeout Settings: Set Timeout property appropriately based on network environment
4. Data Types: All values in Redis are stored as strings, numeric operations require conversion
5. Transaction Safety: Commands in transactions are not executed until Exec or Discard is called
6. Batch Operations: Use MGet, MSet and other batch operations to improve performance
7. Resource Release: Set object to Nothing when no longer in use

Dependencies

• cWinsock - Socket communication component
• ToolsUtf8 - UTF-8 encoding/decoding tool
• Scripting.Dictionary - For HGetAll to return dictionary object

Quick Start

Dim oRedis As New cRedisClient

' Connect to local Redis server
If oRedis.Connect() Then
    Debug.Print "Connected successfully!"

    ' Set key-value
    oRedis.Set_ "name", "Zhang San"

    ' Get value
    Debug.Print "Name: " & oRedis.Get_("name")

    ' Disconnect
    oRedis.DisConnect
Else
    Debug.Print "Connection failed: " & oRedis.LastError
End If

License

Please refer to the main project documentation for license information.