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:maintenance [DATABASE]
heroku redis:maxmemory [DATABASE]
heroku redis:promote DATABASE
heroku redis:timeout [DATABASE]
heroku redis:wait [DATABASE]
heroku redis [DATABASE]
gets information about redisUSAGE
$ heroku redis [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
heroku redis:cli [DATABASE]
opens a redis promptUSAGE
$ heroku redis:cli [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-c, --confirm=confirm
-r, --remote=remote git remote of app to use
heroku redis:credentials [DATABASE]
display credentials informationUSAGE
$ heroku redis:credentials [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
--reset reset credentials
heroku redis:info [DATABASE]
gets information about redisUSAGE
$ heroku redis:info [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
heroku redis:maintenance [DATABASE]
manage maintenance windowsUSAGE
$ heroku redis:maintenance [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-f, --force start maintenance without entering application maintenance mode
-r, --remote=remote git remote of app to use
-w, --window=window set weekly UTC maintenance window
--run start maintenance
DESCRIPTION
Set or change the maintenance window for your Redis instance
heroku redis:maxmemory [DATABASE]
set the key eviction policyUSAGE
$ heroku redis:maxmemory [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-p, --policy=policy (required) set policy name
-r, --remote=remote git remote of app to use
DESCRIPTION
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-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 REDISURLUSAGE
$ heroku redis:promote DATABASE
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
heroku redis:timeout [DATABASE]
set the number of seconds to wait before killing idle connectionsUSAGE
$ heroku redis:timeout [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use
-s, --seconds=seconds set timeout value
DESCRIPTION
Sets the number of seconds to wait before killing idle connections. A value of zero means that connections will not be
closed.
heroku redis:wait [DATABASE]
wait for Redis instance to be availableUSAGE
$ heroku redis:wait [DATABASE]
OPTIONS
-a, --app=app (required) [default: heroku-cli-auth-staging] app to run command against
-r, --remote=remote git remote of app to use