rutil is a small command line utility that lets you selectively dump, restore and query a redis database, peek into stored data and pretty print json contents.
Attention!!! This code is a fork of project
rutilWe try to contact the initial developers: pampa/rutil#6. Parallel to this, improvements were made to the code to be compiled with Go 1.15 and a Docker image was created to facilitate distribution and use.
Credits for:
Thanks @otavioprado for making improvements to the code to be compiled with Go 1.15 and creating the Dockerfile for easy distribution and use.
Clone this repository with command:
git clone https://github.com/Sensedia/rutil
cd rutilInstall Docker following the instructions in this tutorial.
Generate new image with command:
make imageOr:
docker build -t rutil:latest .List the Docker images:
docker imagesRun a container:
docker run --rm rutil --helpMore information about docker run command: https://docs.docker.com/engine/reference/run/
Install Go following the instructions in this tutorial.
Compile rutil with Go:
make buildOr:
go build -o bin/rutil .Run rutil:
./bin/rutil --helprutil [global options] command [command options] [arguments...]
COMMANDS:
dump dump redis database to a file
pipe dump a redis database to stdout in a format compatible with | redis-cli --pipe
restore restore redis database from a file
query, q query keys matching the pattern provided by --keys
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--host value, -s value redis host (default: "127.0.0.1")
--auth value, -a value authentication password
--port value, -p value redis port (default: 6379)
--cluster, -c redis cluster connection
--help, -h show help
--version, -v print the versionrutil [global options] dump [command options] [arguments...]
GLOBAL OPTIONS:
--host value, -s value redis host (default: "127.0.0.1")
--auth value, -a value authentication password
--port value, -p value redis port (default: 6379)
--cluster, -c redis cluster connection
--help, -h show help
--version, -v print the version
OPTIONS:
--keys value, -k value keys pattern (passed to redis 'keys' command) (default: "*")
--match value, -m value regexp filter for key names
--invert, -v invert match regexp
--auto, -a make up a file name for the dump - redisYYYYMMDDHHMMSS.rdmpMake a dump of all keys of Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 dump /tmp/dump_all_keys.rdmpA file will be created /tmp/dump_all_keys.rdmp.
Or:
./bin/rutil -c --host 192.168.0.1 --port 6379 dump -aA file will be created in the current directory with the following pattern: redisYYYYMMDDHHMMSS.rdmp.
Using Docker:
docker run --rm -v $PWD:/tmp rutil -c --host 192.168.0.1 --port 6379 dump /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil -c --host 192.168.0.1 --port 6379 dump -aMake a dump of all keys of Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 dump /tmp/dump_all_keys.rdmpA file will be created /tmp/dump_all_keys.rdmp.
Or:
./bin/rutil --host 192.168.0.1 --port 6379 dump -aA file will be created in the current directory with the following pattern: redisYYYYMMDDHHMMSS.rdmp.
Using Docker (ommiting -c option):
docker run --rm -v $PWD:/tmp rutil --host 192.168.0.1 --port 6379 dump /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil --host 192.168.0.1 --port 6379 dump -arutil [global options] pipe [command options] [arguments...]
GLOBAL OPTIONS:
--host value, -s value redis host (default: "127.0.0.1")
--auth value, -a value authentication password
--port value, -p value redis port (default: 6379)
--cluster, -c redis cluster connection
--help, -h show help
--version, -v print the version
OPTIONS:
--keys value, -k value keys pattern (passed to redis 'keys' command) (default: "*")
--match value, -m value regexp filter for key names
--invert, -v invert match regexprutil [global options] estore [command options] [arguments...]
GLOBAL OPTIONS:
--host value, -s value redis host (default: "127.0.0.1")
--auth value, -a value authentication password
--port value, -p value redis port (default: 6379)
--cluster, -c redis cluster connection
--help, -h show help
--version, -v print the version
OPTIONS:
--dry-run, -r pretend to restore
--flushdb, -f flush the database before restoring
--delete, -d delete key before restoring
--ignore, -g ignore BUSYKEY restore errors
--stdin, -i read dump from STDINSimulate restore all keys of Redis cluster:
./bin/rutil --host 192.168.0.1 -c --port 6379 restore --dry-run /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil -c --host 192.168.0.1 --port 6379 restore --dry-run /tmp/file2.rdmpRestore all keys of Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 restore --flushdb /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil -c --host 192.168.0.1 --port 6379 restore --flushdb /tmp/file2.rdmpSimulate restore all keys of Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 restore --dry-run /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil --host 192.168.0.1 --port 6379 restore --dry-run /tmp/file2.rdmpRestore all keys of Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 restore --flushdb /tmp/file2.rdmpOr:
docker run --rm -v $PWD:/tmp rutil --host 192.168.0.1 --port 6379 restore --flushdb /tmp/file2.rdmprutil [global options] query [command options] [arguments...]
GLOBAL OPTIONS:
--host value, -s value redis host (default: "127.0.0.1")
--auth value, -a value authentication password
--port value, -p value redis port (default: 6379)
--cluster, -c redis cluster connection
--help, -h show help
--version, -v print the version
OPTIONS:
--keys value, -k value keys pattern (passed to redis 'keys' command)
--match value, -m value regexp filter for key names
--invert, -v invert match regexp
--delete delete keys
--print, -p print key values
--field value, -f value hash fields to print (default all)
--json, -j attempt to parse and pretty print strings as jsonList all keys in Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 query --keys '*'Or:
docker run --rm rutil -c --host 192.168.0.1 --port 6379 query --keys '*'Make a query in Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK*'Or:
docker run --rm rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK*'Delete a key in Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --deleteOr:
docker run --rm rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --deletePrint value of a key in Redis cluster:
./bin/rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --printOr:
docker run --rm rutil -c --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --printMore information: https://redis.io/commands/keys
List all keys in Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 query --keys '*'Or:
docker run --rm rutil --host 192.168.0.1 --port 6379 query --keys '*'Make a query in Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK*'Or:
docker run --rm rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK*'Delete a key in Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --deleteOr:
docker run --rm rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --deletePrint value of a key in Redis node (ommiting -c option):
./bin/rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --printOr:
docker run --rm rutil --host 192.168.0.1 --port 6379 query --keys 'testing:abcde:BOOK:55' --printMore information: https://redis.io/commands/keys