go-resp3

go-resp3

go-resp3 client is a Go implementation of the Redis RESP3 protocol. It is intended as a simple Go wrapper for Redis commands and is not going to support

• former Redis protocols (RESP3 only).
• Redis cluster protocol (allthough cluster commands are implemented) - please use Redis Cluster Proxy instead.

Installation

go get github.com/d024441/go-resp3/client

Building

To build go-resp3 you need to have a working Go environment with version 1.13.x or higher installed.

Documentation

API documentation and documented examples can be found at https://godoc.org/github.com/d024441/go-resp3/client.

Tests

To run the driver tests and benchmarks a running Redis server (version >= 6.0) is required. For the Redis connection localhost (127.0.0.1) and the default Redis port is used. The following environment variables can be set to use alternative host and port addresses:

• REDIS_HOST
• REDIS_PORT

Features

• Full RESP3 implementation supporting receiving attributes, streamed strings and streamed aggregate types.
• Standardized generated command interface.
• Asynchronous client with concurrent read / write supporting commands and out of band data within same connection.
• Redis pipeline support.
• Redis server-assisted client side caching.
• Support Redis RESP3 out of bound data: Pubsub, Monitor and key slot invalidations (cache).
• Extendable via custom connection and pipeline (please see example).
• Redis 6 TLS (SSL) support (please see example).

Edge cases

To simplify the command API some of the Redis commands got replaced by a set of commands:

Please see the following table for deprecated Redis commands and their replacements:

Dependencies

• n/a

Todo

This is an early beta version. The client API may be subject to change until the first stable version is available.