npm package: @heroku-cli/plugin-data-maintenance
Description: [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) ![GitHub Actions CI](https://github.com/heroku/heroku-cli-plugin-data-maintenance/actions/workflows/ci.yml/badge.svg)
Author: Heroku
Latest version: 0.3.3

# Heroku CLI Data Maintenance Plugin

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
![GitHub Actions CI](https://github.com/heroku/heroku-cli-plugin-data-maintenance/actions/workflows/ci.yml/badge.svg)

**NOTE**: This plugin has been archived and is no longer maintained.


<!-- toc -->
* [Heroku CLI Data Maintenance Plugin](#heroku-cli-data-maintenance-plugin)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage

```sh-session
$ 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
<!-- commands -->
* [`heroku data:maintenances`](#heroku-datamaintenances)
* [`heroku data:maintenances:history ADDON`](#heroku-datamaintenanceshistory-addon)
* [`heroku data:maintenances:info ADDON`](#heroku-datamaintenancesinfo-addon)
* [`heroku data:maintenances:run ADDON`](#heroku-datamaintenancesrun-addon)
* [`heroku data:maintenances:schedule ADDON`](#heroku-datamaintenancesschedule-addon)
* [`heroku data:maintenances:wait ADDON`](#heroku-datamaintenanceswait-addon)
* [`heroku data:maintenances:window ADDON`](#heroku-datamaintenanceswindow-addon)
* [`heroku data:maintenances:window:update ADDON DAY_OF_WEEK TIME_OF_DAY`](#heroku-datamaintenanceswindowupdate-addon-day_of_week-time_of_day)

## `heroku data:maintenances`

list maintenances for an app's data addons

```
USAGE
  $ heroku data:maintenances -a <value> [-j] [-r <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>]
    [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -a, --app=<value>      (required) app to list addon maintenances for
  -j, --json             output result in json
  -r, --remote=<value>   git remote of app to use
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   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
      --output=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  list maintenances for an app's data addons

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

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

_See code: [src/commands/data/maintenances/index.ts](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-j] [-n <value>] [-r <value>] [--columns <value> | -x] [--sort
    <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

ARGUMENTS
  ADDON  data addon

FLAGS
  -a, --app=<value>      app to run command against
  -j, --json             show result formatted in json
  -n, --num=<value>      [default: 5] number of maintenances to show (maxmimum is 20)
  -r, --remote=<value>   git remote of app to use
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --filter=<value>   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
      --output=<option>  output in a more machine friendly format
                         <options: csv|json|yaml>
      --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  show details of the most recent maintenances for an addon

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](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-j] [-r <value>]

ARGUMENTS
  ADDON  data addon to show maintenance for

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

DESCRIPTION
  display details of the most recent maintenance for an addon

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](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-c <value>] [-r <value>] [-w]

ARGUMENTS
  ADDON  data addon

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

DESCRIPTION
  triggers a scheduled maintenance for a data add-on

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](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-r <value>] [--week <value> | --weeks <value>]

ARGUMENTS
  ADDON  addon to schedule or re-schedule maintenance for

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

DESCRIPTION
  schedule or re-schedule maintenance for an add-on

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](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/src/commands/data/maintenances/schedule.ts)_

## `heroku data:maintenances:wait ADDON`

blocks until the maintenance process has completed

```
USAGE
  $ heroku data:maintenances:wait ADDON [-a <value>] [-r <value>]

ARGUMENTS
  ADDON  data addon

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  blocks until the maintenance process has completed

EXAMPLES
  $ heroku data:maintenances:wait postgresql-sinuous-83720

  $ heroku data:maintenances:wait DATABASE --app production-app
```

_See code: [src/commands/data/maintenances/wait.ts](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-j] [-r <value>]

ARGUMENTS
  ADDON  addon to show window for

FLAGS
  -a, --app=<value>     app to run command against
  -j, --json            output result in json
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  describe the maintenance window on an add-on

EXAMPLES
  $ heroku data:maintenances:window postgresql-sinuous-92834

  $ heroku data:maintenances:window DATABASE --app production-app
```

_See code: [src/commands/data/maintenances/window.ts](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/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 [-a <value>] [-j] [-r <value>]

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

FLAGS
  -a, --app=<value>     app to run command against
  -j, --json            output result in json
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  update maintenance window on an add-on

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](https://github.com/heroku/heroku-cli-plugin-data-maintenance/blob/v0.3.3/src/commands/data/maintenances/window/update.ts)_
<!-- commandsstop -->