@heroku-cli/plugin-redis-v5
v8.11.1
Published
Heroku plugin to manage Heroku Redis
Downloads
22,406
Maintainers
Keywords
Readme
heroku-redis-jsplugin
An Heroku CLI plugin for managing Heroku Redis instances.
Installation
Use plugins:install
to install it:
heroku plugins:install heroku-redis
Usage
CLI commands are described in the Heroku Redis devcenter article.
Publishing
To publish new versions, see the data plugin documentation.
heroku redis [DATABASE]
heroku redis:cli [DATABASE]
heroku redis:credentials [DATABASE]
heroku redis:info [DATABASE]
heroku redis:keyspace-notifications [DATABASE]
heroku redis:maintenance [DATABASE]
heroku redis:maxmemory [DATABASE]
heroku redis:promote DATABASE
heroku redis:stats-reset [DATABASE]
heroku redis:timeout [DATABASE]
heroku redis:upgrade [DATABASE]
heroku redis:wait [DATABASE]
heroku redis [DATABASE]
gets information about redis
USAGE
$ heroku redis [DATABASE] -a <value> [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json format output as JSON
DESCRIPTION
gets information about redis
heroku redis:cli [DATABASE]
opens a redis prompt
USAGE
$ heroku redis:cli [DATABASE] -a <value> [-c <value>] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-c, --confirm=<value>
-r, --remote=<value> git remote of app to use
DESCRIPTION
opens a redis prompt
heroku redis:credentials [DATABASE]
display credentials information
USAGE
$ heroku redis:credentials [DATABASE] -a <value> [--reset] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--reset reset credentials
DESCRIPTION
display credentials information
heroku redis:info [DATABASE]
gets information about redis
USAGE
$ heroku redis:info [DATABASE] -a <value> [--json] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--json format output as JSON
DESCRIPTION
gets information about redis
heroku redis:keyspace-notifications [DATABASE]
set the keyspace notifications configuration
USAGE
$ heroku redis:keyspace-notifications [DATABASE] -c <value> -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-c, --config=<value> (required) set keyspace notifications configuration
-r, --remote=<value> git remote of app to use
DESCRIPTION
set the keyspace notifications configuration
Set the configuration to enable keyspace notification events:
K Keyspace events, published with __keyspace@<db>__ prefix.
E Keyevent events, published with __keyevent@<db>__ prefix.
g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
$ String commands
l List commands
s Set commands
h Hash commands
z Sorted set commands
t Stream commands
x Expired events (events generated every time a key expires)
e Evicted events (events generated when a key is evicted for maxmemory)
m Key miss events (events generated when a key that doesn't exist is accessed)
A Alias for "g$lshztxe", so that the "AKE" string means all the events except "m".
pass an empty string ('') to disable keyspace notifications
heroku redis:maintenance [DATABASE]
manage maintenance windows
USAGE
$ heroku redis:maintenance [DATABASE] -a <value> [-w <value>] [--run] [-f] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-f, --force start maintenance without entering application maintenance mode
-r, --remote=<value> git remote of app to use
-w, --window=<value> set weekly UTC maintenance window
--run start maintenance
DESCRIPTION
manage maintenance windows
Set or change the maintenance window for your Redis instance
heroku redis:maxmemory [DATABASE]
set the key eviction policy
USAGE
$ heroku redis:maxmemory [DATABASE] -p <value> -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-p, --policy=<value> (required) set policy name
-r, --remote=<value> git remote of app to use
DESCRIPTION
set the key eviction policy
Set the key eviction policy when instance reaches its storage limit. Available policies for key eviction include:
noeviction # returns errors when memory limit is reached
allkeys-lfu # removes less frequently used keys first
volatile-lfu # removes less frequently used keys first that have an expiry set
allkeys-lru # removes less recently used keys first
volatile-lru # removes less recently used keys first that have an expiry set
allkeys-random # evicts random keys
volatile-random # evicts random keys but only those that have an expiry set
volatile-ttl # only evicts keys with an expiry set and a short TTL
heroku redis:promote DATABASE
sets DATABASE as your REDIS_URL
USAGE
$ heroku redis:promote DATABASE -a <value> [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
DESCRIPTION
sets DATABASE as your REDIS_URL
heroku redis:stats-reset [DATABASE]
reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat)
USAGE
$ heroku redis:stats-reset [DATABASE] -a <value> [-c <value>] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-c, --confirm=<value>
-r, --remote=<value> git remote of app to use
DESCRIPTION
reset all stats covered by RESETSTAT (https://redis.io/commands/config-resetstat)
heroku redis:timeout [DATABASE]
set the number of seconds to wait before killing idle connections
USAGE
$ heroku redis:timeout [DATABASE] -a <value> [-s <value>] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
-s, --seconds=<value> set timeout value
DESCRIPTION
set the number of seconds to wait before killing idle connections
Sets the number of seconds to wait before killing idle connections. A value of zero means that connections will not be
closed.
heroku redis:upgrade [DATABASE]
perform in-place version upgrade
USAGE
$ heroku redis:upgrade [DATABASE] -a <value> [-c <value>] [-v <value>] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-c, --confirm=<value>
-r, --remote=<value> git remote of app to use
-v, --version=<value>
DESCRIPTION
perform in-place version upgrade
heroku redis:wait [DATABASE]
wait for Redis instance to be available
USAGE
$ heroku redis:wait [DATABASE] -a <value> [--wait-interval <value>] [-r <value>]
FLAGS
-a, --app=<value> (required) app to run command against
-r, --remote=<value> git remote of app to use
--wait-interval=<value> how frequently to poll in seconds
DESCRIPTION
wait for Redis instance to be available