Package upstashdis provides a Go client for the Upstash Redis REST API interface. Note that this package is not affiliated with Upstash. It also provides a restserver Go package and an upstash-redis-rest-server executable command to run a local web server that serves an Upstash-compatible REST API in front of an actual Redis database instance, for testing purposes.
Go1.18+ is required. To install the packages for use in a Go project:
$ go get github.com/mna/upstashdisTo install only the REST server command:
$ go install github.com/mna/upstashdis/cmd/upstash-redis-rest-server@latestThe code documentation is the canonical source for the Go packages documentation.
The upstash-redis-rest-server command documentation is available by running the command with the --help flag and is shown here as a convenience:
usage: upstash-redis-rest-server --addr <ADDR> --redis-addr <ADDR> [--api-token <TOKEN>]
upstash-redis-rest-server --help
Run a web server that serves an Upstash-compatible Redis REST API and
connects to a running Redis instance to execute commands.
Valid flag options are:
-a --addr ADDR Address for the web server to listen on.
-h --help Show this help.
-r --redis-addr ADDR Use the Redis instance running at this
ADDR to execute commands.
-t --api-token TOKEN API token to accept as authorized. Can
also be set via the environment variable
UPSTASH_REDIS_REST_SERVER_API_TOKEN.
The redis instance should be version 6 and above for better
compatibility.
As a special case, 'memory' can be used as --redis-addr and a miniredis
instance will be used. Note that not all commands are supported by
miniredis - in particular, ACL commands are not supported. See the
miniredis repository and documentation for more information:
https://github.com/alicebob/miniredis.
More information on the upstashdis repository:
https://github.com/mna/upstashdis
The BSD 3-Clause license.