@heroku-cli/plugin-data-maintenance

0.3.0 • Public • Published

Heroku CLI Data Maintenance Plugin

oclif GitHub Actions CI

Usage

$ heroku plugins:install data-maintenance
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-data-maintenance/0.2.2 darwin-x64 node-v14.9.0
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

heroku data:maintenances

list maintenances for an app's data addons

USAGE
  $ heroku data:maintenances

OPTIONS
  -a, --app=app        (required) app to list addon maintenances for
  -j, --json           output result in json
  -r, --remote=remote  git remote of app to use
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLES
  $ heroku data:maintenances --app production-app
  $ heroku data:maintenances --app production-app --json

See code: src/commands/data/maintenances/index.ts

heroku data:maintenances:history ADDON

show details of the most recent maintenances for an addon

USAGE
  $ heroku data:maintenances:history ADDON

ARGUMENTS
  ADDON  data addon

OPTIONS
  -a, --app=app        app to run command against
  -j, --json           show result formatted in json
  -n, --num=num        [default: 5] number of maintenances to show (maxmimum is 20)
  -r, --remote=remote  git remote of app to use
  -x, --extended       show extra columns
  --columns=columns    only show provided columns (comma-separated)
  --csv                output is csv format
  --filter=filter      filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --sort=sort          property to sort by (prepend '-' for descending)

EXAMPLES
  $ heroku data:maintenances:history postgresql-sinuous-92834
  $ heroku data:maintenances:history postgresql-sinuous-92834 --num 10
  $ heroku data:maintenances:history postgresql-sinuous-92834 --json
  $ heroku data:maintenances:history DATABASE --app production-app

See code: src/commands/data/maintenances/history.ts

heroku data:maintenances:info ADDON

display details of the most recent maintenance for an addon

USAGE
  $ heroku data:maintenances:info ADDON

ARGUMENTS
  ADDON  data addon to show maintenance for

OPTIONS
  -a, --app=app        app to list addon maintenances for
  -j, --json           output result in json
  -r, --remote=remote  git remote of app to use

EXAMPLES
  $ heroku data:maintenances:info postgresql-sinuous-83720
  $ heroku data:maintenances:info postgresql-sinuous-83720 --json
  $ heroku data:maintenances:info DATABASE --app test-app

See code: src/commands/data/maintenances/info.ts

heroku data:maintenances:run ADDON

triggers a scheduled maintenance for a data add-on

USAGE
  $ heroku data:maintenances:run ADDON

ARGUMENTS
  ADDON  data addon

OPTIONS
  -a, --app=app          app to run command against
  -c, --confirm=confirm  confirms running maintenance without entering application maintenance mode the app name matches
  -r, --remote=remote    git remote of app to use
  -w, --wait             wait for maintenance to complete before exiting

EXAMPLES
  $ heroku data:maintenances:run postgresql-sinuous-92834
  $ heroku data:maintenances:run postgresql-sinuous-92834 --confirm production-app
  $ heroku data:maintenances:run postgresql-sinuous-92834 --wait
  $ heroku data:maintenances:run DATABASE --app production-app

See code: src/commands/data/maintenances/run.ts

heroku data:maintenances:schedule ADDON

schedule or re-schedule maintenance for an add-on

USAGE
  $ heroku data:maintenances:schedule ADDON

ARGUMENTS
  ADDON  addon to schedule or re-schedule maintenance for

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use
  --week=week          desired week to run maintenance in
  --weeks=weeks        [default: 2] the number of weeks to delay maintenance for

EXAMPLES
  $ heroku data:maintenances:schedule postgresql-sinuous-83910
  $ heroku data:maintenances:schedule postgresql-sinuous-83910 --weeks 3
  $ heroku data:maintenances:schedule postgresql-sinuous-83910 --weeks -2
  $ heroku data:maintenances:schedule postgresql-sinuous-83910 --week 2020-02-23
  $ heroku data:maintenances:schedule HEROKU_POSTGRESQL_RED --app test-app

See code: src/commands/data/maintenances/schedule.ts

heroku data:maintenances:wait ADDON

blocks until the maintenance process has completed

USAGE
  $ heroku data:maintenances:wait ADDON

ARGUMENTS
  ADDON  data addon

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLES
  $ heroku data:maintenances:wait postgresql-sinuous-83720
  $ heroku data:maintenances:wait DATABASE --app production-app

See code: src/commands/data/maintenances/wait.ts

heroku data:maintenances:window ADDON

describe the maintenance window on an add-on

USAGE
  $ heroku data:maintenances:window ADDON

ARGUMENTS
  ADDON  addon to show window for

OPTIONS
  -a, --app=app        app to run command against
  -j, --json           output result in json
  -r, --remote=remote  git remote of app to use

EXAMPLES
  $ heroku data:maintenances:window postgresql-sinuous-92834
  $ heroku data:maintenances:window DATABASE --app production-app

See code: src/commands/data/maintenances/window.ts

heroku data:maintenances:window:update ADDON DAY_OF_WEEK TIME_OF_DAY

update maintenance window on an add-on

USAGE
  $ heroku data:maintenances:window:update ADDON DAY_OF_WEEK TIME_OF_DAY

ARGUMENTS
  ADDON        addon to change window for
  DAY_OF_WEEK  UTC maintenance window day of the week
  TIME_OF_DAY  UTC maintenance window time of day

OPTIONS
  -a, --app=app        app to run command against
  -j, --json           output result in json
  -r, --remote=remote  git remote of app to use

EXAMPLES
  $ heroku data:maintenances:window postgresql-sinuous-92834 sunday 13:30
  $ heroku data:maintenances:window postgresql-sinuous-92834 sunday 1:30PM
  $ heroku data:maintenances:window DATABASE sunday 1:30PM --app production-app

See code: src/commands/data/maintenances/window/update.ts

/@heroku-cli/plugin-data-maintenance/

    Package Sidebar

    Install

    npm i @heroku-cli/plugin-data-maintenance

    Weekly Downloads

    185

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    184 kB

    Total Files

    31

    Last publish

    Collaborators

    • brittany.jones
    • marcusblankenship
    • nilamuthu
    • dpark.heroku
    • cgfuh
    • grismar17
    • sbosio_sf
    • hillzbot2000
    • kdreyeroren
    • beanieboi
    • beckychen
    • xx-sfdc-npm
    • kpremkumar
    • abhinavkoul
    • daniel.bright
    • justinwilaby-sf
    • cv88
    • jlopezdan
    • jmonreal
    • jondaniel-sfdc
    • dhagberg-sf
    • elzoona
    • cmarcojos
    • gkommineni
    • vlazuka
    • nlanatta
    • lucaszhou
    • mars
    • mimen
    • wchrisjohnson
    • cbaxtersf
    • heroku-front-end
    • zli-sf
    • 7ftz
    • joanneyeung
    • montes_heroku
    • jwadsworthsf
    • jheikes
    • lmckenzie
    • sarassassin
    • pfuente
    • reidmix
    • mbuschheroku
    • k.plenty
    • eblack
    • sheax0r
    • k80bowman
    • rdagg-hero
    • grundy.g
    • robinson.m
    • tcareysmith-sfdc
    • ptemporini
    • paulaprado18
    • harish.457
    • ntonollier