@heroku-cli/plugin-data-beta

Heroku CLI Data Beta Plugin

Heroku CLI Plugin for beta Heroku Data features.

• Heroku CLI Data Beta Plugin
• Installation
• Usage
• Commands

Installation

$ heroku plugins:install data-beta

Usage

$ npm install -g @heroku-cli/plugin-data-beta
$ heroku COMMAND
running command...
$ heroku (--version)
@heroku-cli/plugin-data-beta/0.0.1 darwin-x64 node-v20.18.3
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

• heroku data:pg:create TIER
• heroku data:pg:destroy ADDON
• heroku data:pg:docs
• heroku data:pg:info ADDON
• heroku data:pg:psql DATABASE
• heroku data:pg:scale ADDON

heroku data:pg:create TIER

Create a postgres performance addon

USAGE
  $ heroku data:pg:create TIER -a <value> [--level <value>] [--name <value>] [--as <value>] [--wait]
    [--high-availability] [--network private|shield] [--readers <value>]

ARGUMENTS
  TIER  (performance) Postgres tier

FLAGS
  -a, --app=<value>             (required) app to run command against
      --as=<value>              Name for the initial add-on attachment
      --[no-]high-availability  Enable a high availability cluster by provisioning a warm standby writer.
      --level=<value>           Set compute scale
      --name=<value>            Name for the add-on resource
      --network=<option>        Networking for the add-on
                                <options: private|shield>
      --readers=<value>         Provisions a reader instance pool with the specified number of instances
      --wait                    Watch add-on creation status and exit when complete

DESCRIPTION
  Create a postgres performance addon

EXAMPLES
  $ heroku data:pg:create performance --level 4G-Performance

See code: src/commands/data/pg/create.ts

heroku data:pg:destroy ADDON

Destroy a postgres performance database

USAGE
  $ heroku data:pg:destroy ADDON [-f] [-c <value>] [--wait] [-a <value>]

ARGUMENTS
  ADDON  Name of the database, its attachment name, or related config var on an app

FLAGS
  -a, --app=<value>      app to run command against
  -c, --confirm=<value>  Skip confirmation prompts by passing in app name
  -f, --force            allow destruction even if connected to other apps
      --wait             watch database destruction status and exit when complete

DESCRIPTION
  Destroy a postgres performance database

EXAMPLES
  $ heroku data:pg:destroy database_name

See code: src/commands/data/pg/destroy.ts

heroku data:pg:docs

Opens documentation for Heroku Postgres in your web browser.

USAGE
  $ heroku data:pg:docs [--browser <value>]

FLAGS
  --browser=<value>  browser to open docs with (example: "firefox", "safari")

DESCRIPTION
  Opens documentation for Heroku Postgres in your web browser.

See code: src/commands/data/pg/docs.ts

heroku data:pg:info ADDON

Get Postgres Addon Info

USAGE
  $ heroku data:pg:info ADDON [-a <value>]

ARGUMENTS
  ADDON  Name of the addon, its attachment name, or related config var on an app

FLAGS
  -a, --app=<value>  app to run command against

DESCRIPTION
  Get Postgres Addon Info

EXAMPLES
  $ heroku data:pg:info addon_name

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

heroku data:pg:psql DATABASE

open a psql shell to the database

USAGE
  $ heroku data:pg:psql DATABASE -a <value> [-c <value>] [--credential <value>] [-f <value>] [-p <value>] [-r
    <value>]

ARGUMENTS
  DATABASE  Name of the addon, its attachment name, or related config var on an app

FLAGS
  -a, --app=<value>         (required) app to run command against
  -c, --command=<value>     SQL command to run
  -f, --file=<value>        SQL file to run
  -p, --pool=<value>        reader instance pool to connect to (only Performance-tier databases)
  -r, --remote=<value>      git remote of app to use
      --credential=<value>  credential to use

DESCRIPTION
  open a psql shell to the database

See code: src/commands/data/pg/psql.ts

heroku data:pg:scale ADDON

Scale your postgres addon

USAGE
  $ heroku data:pg:scale ADDON -a <value> [--count <value>] [--level <value>] [--pool <value>]
    [--high-availability] [--confirm <value>]

ARGUMENTS
  ADDON  Name of the addon to scale. If targeting an app, an env var associate with the addon may be used

FLAGS
  -a, --app=<value>             (required) app to run command against
      --confirm=<value>         Confirm scale action
      --count=<value>           Adjust the instance count of a pool
      --[no-]high-availability  Enable a high availability cluster by provisioning a warm standby writer
      --level=<value>           Adjust compute scale
      --pool=<value>            Adds a named instance pool when one does not exist or scales the instance pool which
                                exists based on level and instance flags

DESCRIPTION
  Scale your postgres addon

EXAMPLES
  $ heroku data:pg:scale

See code: src/commands/data/pg/scale.ts