npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

borealis-pg-cli

v1.7.1

Published

CLI for advanced interactions with Borealis Isolated Postgres add-ons

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

oldsneerjawoldsneerjaw

Keywords

oclif-plugin

Readme

borealis-pg-cli

This plugin for the Heroku CLI enables various advanced interactions with a Borealis Isolated Postgres add-on. See our CLI documentation for help getting started and for additional examples.

oclif Version License

Installation

First, ensure the Heroku CLI is installed, then execute the following from a terminal:

$ heroku plugins:install borealis-pg-cli

Commands

heroku borealis-pg

Show information about a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Show information about a Borealis Isolated Postgres add-on database

See code: src/commands/borealis-pg/index.ts

heroku borealis-pg:extensions

List installed PostgreSQL extensions for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:extensions [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  List installed PostgreSQL extensions for a Borealis Isolated Postgres add-on

See code: src/commands/borealis-pg/extensions/index.ts

heroku borealis-pg:extensions:install PG_EXTENSION

Install a PostgreSQL extension on a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg:extensions:install PG_EXTENSION [-o <value>] [-a <value>] [-r] [-s]

ARGUMENTS
  PG_EXTENSION  name of a Postgres extension

FLAGS
  -a, --app=<value>        app to which the add-on is attached
  -o, --addon=<value>      name or ID of an add-on or one of its attachments
  -r, --recursive          automatically install Postgres extension dependencies recursively
  -s, --suppress-conflict  suppress nonzero exit code when an extension is already installed

DESCRIPTION
  Install a PostgreSQL extension on a Borealis Isolated Postgres add-on database

  Each extension is typically installed with its own dedicated database schema,
  which may be used to store types, functions, tables or other objects that are
  part of the extension.

  If an extension has any unsatisfied dependencies, its dependencies will be
  installed automatically only if the --recursive option is provided.

  Details of all supported extensions can be found here:
  https://www.borealis-data.com/pg-extensions-support.html

EXAMPLES
  $ heroku borealis-pg:extensions:install --recursive --app sushi hstore_plperl

  $ heroku borealis-pg:extensions:install --app sushi --addon BOREALIS_PG_MAROON bloom

  $ heroku borealis-pg:extensions:install --suppress-conflict --addon borealis-pg-hex-12345 pg_trgm

See code: src/commands/borealis-pg/extensions/install.ts

heroku borealis-pg:extensions:remove PG_EXTENSION

Remove a PostgreSQL extension from a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg:extensions:remove PG_EXTENSION [-o <value>] [-a <value>] [-c <value>] [-s]

ARGUMENTS
  PG_EXTENSION  name of a Postgres extension

FLAGS
  -a, --app=<value>       app to which the add-on is attached
  -c, --confirm=<value>   bypass the prompt for confirmation by specifying the name of the extension
  -o, --addon=<value>     name or ID of an add-on or one of its attachments
  -s, --suppress-missing  suppress nonzero exit code when an extension is not installed

DESCRIPTION
  Remove a PostgreSQL extension from a Borealis Isolated Postgres add-on database

EXAMPLES
  $ heroku borealis-pg:extensions:remove --suppress-missing --app sushi postgis

  $ heroku borealis-pg:extensions:remove --app sushi --addon BOREALIS_PG_MAROON btree_gist

  $ heroku borealis-pg:extensions:remove --confirm uuid-ossp --addon borealis-pg-hex-12345 uuid-ossp

See code: src/commands/borealis-pg/extensions/remove.ts

heroku borealis-pg:info

Show information about a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg:info [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Show information about a Borealis Isolated Postgres add-on database

See code: src/commands/borealis-pg/info.ts

heroku borealis-pg:integrations

List registered data integrations for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:integrations [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  List registered data integrations for a Borealis Isolated Postgres add-on

  A data integration allows a third party service access to an add-on database
  via a secure tunnel using semi-permanent SSH server and database credentials.

See code: src/commands/borealis-pg/integrations/index.ts

heroku borealis-pg:integrations:register SSH_PUBLIC_KEY

Register a data integration for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:integrations:register SSH_PUBLIC_KEY -n <value> [-o <value>] [-a <value>] [-w]

ARGUMENTS
  SSH_PUBLIC_KEY  an SSH public key to authorize for access

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -n, --name=<value>   (required) name of the add-on data integration
  -o, --addon=<value>  name or ID of an add-on or one of its attachments
  -w, --write-access   allow write access to the add-on Postgres database

DESCRIPTION
  Register a data integration for a Borealis Isolated Postgres add-on

  A data integration allows a third party service access to an add-on database
  via a secure tunnel using semi-permanent SSH server and database credentials.
  Typical uses include extract, transform and load (ETL) services and data
  warehouses.

  An SSH public key is required for SSH client authorization. It must be an RSA,
  ECDSA or Ed25519 public key in OpenSSH format. It will typically be provided
  to you by the third party service.

  The --name option is used internally to identify a data integration and to
  generate a unique database username for it; it must must consist only of
  lowercase letters, digits and underscores (_), and have between 1 and 25
  characters.

  Note that, in some cases, the service may require read and write access to an
  add-on database, in which case you can supply the --write-access option.

  The output includes an SSH server public host key value. This can be used to
  validate the identity of the SSH server if the data integration service
  supports it.

EXAMPLES
  $ heroku borealis-pg:integrations:register --app sushi --name my_integration1 ssh-ed25519 SSHPUBLICKEY1===

  $ heroku borealis-pg:integrations:register --write-access --app sushi --name my_integration2 ssh-rsa SSHPUBLICKEY2===

See code: src/commands/borealis-pg/integrations/register.ts

heroku borealis-pg:integrations:remove

Remove a data integration from a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:integrations:remove -n <value> [-o <value>] [-a <value>] [-c <value>]

FLAGS
  -a, --app=<value>      app to which the add-on is attached
  -c, --confirm=<value>  bypass the confirmation prompt by providing the name of the integration
  -n, --name=<value>     (required) name of the add-on data integration
  -o, --addon=<value>    name or ID of an add-on or one of its attachments

DESCRIPTION
  Remove a data integration from a Borealis Isolated Postgres add-on

ALIASES
  $ heroku borealis-pg:integrations:deregister

EXAMPLES
  $ heroku borealis-pg:integrations:remove --app sushi --name my_integration1

  $ heroku borealis-pg:integrations:remove --confirm my_integration2 --app sushi --name my_integration2

See code: src/commands/borealis-pg/integrations/remove.ts

heroku borealis-pg:psql

Run psql with a secure tunnel to a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:psql [-o <value>] [-a <value>] [-b <value>] [-p <value>] [-w]

FLAGS
  -a, --app=<value>          app to which the add-on is attached
  -b, --binary-path=<value>  custom path to a psql binary
  -o, --addon=<value>        name or ID of an add-on or one of its attachments
  -p, --port=<value>         [default: 5432] local port number for the secure tunnel to the add-on Postgres server
  -w, --write-access         allow write access to the add-on Postgres database

DESCRIPTION
  Run psql with a secure tunnel to a Borealis Isolated Postgres add-on

  This operation establishes a temporary secure tunnel to an add-on database to
  provide an interactive psql session. It requires that the psql command is
  installed on the local machine; generally, psql is installed along with
  PostgreSQL (https://www.postgresql.org/download/).

  The psql session will be initiated as a database user role that is
  specifically tied to the current Heroku user account. By default the user role
  allows read-only access to the add-on database; to enable read and write
  access, supply the --write-access option.

  Note that any tables, indexes, views or other objects that are created when
  connected as a personal user role will be owned by that user role rather than
  the application database user role unless ownership is explicitly reassigned
  afterward (for example, by using the REASSIGN OWNED command).

  To override the path to the psql binary, supply the --binary-path option.

  See also the borealis-pg:run command to execute a noninteractive script or the
  borealis-pg:tunnel command to start a secure tunnel session that can be used
  in combination with any PostgreSQL client (e.g. a graphical user interface like
  pgAdmin).

EXAMPLES
  $ heroku borealis-pg:psql --app sushi --binary-path /path/to/psql

  $ heroku borealis-pg:psql --app sushi --addon BOREALIS_PG_MAROON --write-access

  $ heroku borealis-pg:psql --addon borealis-pg-hex-12345

See code: src/commands/borealis-pg/psql.ts

heroku borealis-pg:restore:capabilities

Show the restore capabilities of a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg:restore:capabilities [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Show the restore capabilities of a Borealis Isolated Postgres add-on database

  Qualifying add-on databases may be restored to an earlier point in time or
  cloned. This operation outputs the earliest and latest points in time to which
  an add-on database may be restored when supported. Note that, when an add-on
  database is cloned, it will produce a physical copy as at the current time,
  regardless of the add-on's reported latest restorable time.

  See the borealis-pg:restore:execute command to perform a restore/clone.

ALIASES
  $ heroku borealis-pg:restore:info

See code: src/commands/borealis-pg/restore/capabilities.ts

heroku borealis-pg:restore:execute

Restore or clone a Borealis Isolated Postgres add-on database

USAGE
  $ heroku borealis-pg:restore:execute [-o <value>] [-a <value>] [--as <value>] [-d <value>] [-n <value>] [-t <value>]
  [--wait]

FLAGS
  -a, --app=<value>              app to which the source add-on is attached
  -d, --destination-app=<value>  [default: source add-on app] app to attach the new add-on to
  -n, --new-plan=<value>         [default: source add-on plan] add-on plan to apply to the new add-on
  -o, --addon=<value>            name or ID of the source add-on or one of its attachments
  -t, --restore-to-time=<value>  [default: now] date/time (in ISO 8601 format) to restore to
  --as=<value>                   name to assign to the new add-on attachment
  --wait                         wait until the add-on has finished before exiting

DESCRIPTION
  Restore or clone a Borealis Isolated Postgres add-on database

  Qualifying add-on databases may be restored to an earlier point in time or
  cloned. This operation restores/clones the add-on database into a brand new
  add-on database, leaving the original add-on database unaffected. Note that,
  when an add-on database is cloned (that is, the --restore-to-time option is
  omitted), it will produce a physical copy as at the current time, regardless
  of the add-on's reported latest restorable time.

  See the borealis-pg:restore:capabilities command to determine the earliest and
  latest restorable times of an add-on.

EXAMPLES
  $ heroku borealis-pg:restore:execute --app sushi --addon SOURCE_DB --as CLONED_DB

  $ heroku borealis-pg:restore:execute --app sushi --restore-to-time 2023-02-24T18:42:00-08:00

  $ heroku borealis-pg:restore:execute --app sushi --destination-app my-other-app --new-plan x2-s100-p2-r8

See code: src/commands/borealis-pg/restore/execute.ts

heroku borealis-pg:run

Run a command with a secure tunnel to a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:run [-o <value>] [-a <value>] [-d <value> | -i <value> | -e <value>] [-f table|csv|json|yaml |
    ] [-u] [-p <value>] [-w]

FLAGS
  -a, --app=<value>          app to which the add-on is attached
  -d, --db-cmd=<value>       database command to execute over the secure tunnel
  -e, --shell-cmd=<value>    shell command to execute when the secure tunnel is established
  -f, --format=<option>      [default: table] output format for database command results
                             <options: table|csv|json|yaml>
  -i, --db-cmd-file=<value>  UTF-8 file containing database command(s) to execute over the secure tunnel
  -o, --addon=<value>        name or ID of an add-on or one of its attachments
  -p, --port=<value>         [default: 5432] local port number for the secure tunnel to the add-on Postgres server
  -u, --personal-user        run as a personal user rather than a user belonging to the Heroku application
  -w, --write-access         allow write access to the add-on Postgres database

DESCRIPTION
  Run a command with a secure tunnel to a Borealis Isolated Postgres add-on

  An add-on Postgres database is, by design, inaccessible from outside of its
  virtual private cloud. As such, this operation establishes an ephemeral secure
  tunnel to an add-on database to execute a provided noninteractive command, then
  immediately closes the tunnel.

  A command can take the form of a database command or a shell command. In either
  case, it is executed using the Heroku application's dedicated database user
  role by default, but it can be made to execute as a database user role that is
  specifically tied to the current Heroku user account via the --personal-user
  option instead. Note that any tables, indexes, views or other objects that are
  created when connected as a personal user role will be owned by that user role
  rather than the Heroku application user role unless ownership is explicitly
  reassigned afterward (for example, by using the REASSIGN OWNED command).

  Regardless of whether running as the Heroku application's database user role
  or as a personal user role, the command will have read-only access to the
  add-on database by default; to enable read and write access, supply the
  --write-access option.

  Database commands are raw statements (e.g. SQL, PL/pgSQL) that are sent over
  the secure tunnel to the add-on Postgres database to be executed verbatim, with
  the results then written to the console on stdout.

  Shell commands are useful for executing an application's database migration
  scripts or other unattended database scripts. They are executed in a shell on
  the local machine with the following environment variables automatically set to
  allow scripts and applications that are launched by the command to connect over
  the secure tunnel to the remote add-on Postgres database:
  - PGHOST
  - PGPORT
  - PGDATABASE
  - PGUSER
  - PGPASSWORD
  - DATABASE_URL

  See also the borealis-pg:psql command to launch an interactive psql session or
  the borealis-pg:tunnel command to start a secure tunnel session that can be
  used in combination with any PostgreSQL client (e.g. a graphical user interface
  like pgAdmin).

EXAMPLES
  $ heroku borealis-pg:run --app sushi --db-cmd 'SELECT * FROM hello_greeting' --format csv

  $ heroku borealis-pg:run --app sushi --addon BOREALIS_PG_MAROON --db-cmd-file ~/scripts/example.sql --personal-user

  $ heroku borealis-pg:run --addon borealis-pg-hex-12345 --shell-cmd './manage.py migrate' --write-access

See code: src/commands/borealis-pg/run.ts

heroku borealis-pg:tunnel

Establish a secure tunnel to a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:tunnel [-o <value>] [-a <value>] [-p <value>] [-w]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments
  -p, --port=<value>   [default: 5432] local port number for the secure tunnel to the add-on Postgres server
  -w, --write-access   allow write access to the add-on Postgres database

DESCRIPTION
  Establish a secure tunnel to a Borealis Isolated Postgres add-on

  This operation allows for a secure, temporary session connection to an add-on
  Postgres database that is, by design, otherwise inaccessible from outside of
  its virtual private cloud. Once a tunnel is established, use a tool such as
  psql or pgAdmin and the provided user credentials to interact with the add-on
  database.

  The credentials that will be provided belong to a database user role that is
  specifically tied to the current Heroku user account. By default the user role
  allows read-only access to the add-on database; to enable read and write
  access, supply the --write-access option.

  Note that any tables, indexes, views or other objects that are created when
  connected as a personal user role will be owned by that user role rather than
  the application database user role unless ownership is explicitly reassigned
  afterward (for example, by using the REASSIGN OWNED command).

  See also the borealis-pg:run command to execute a noninteractive script or the
  borealis-pg:psql command to launch an interactive psql session directly.

EXAMPLES
  $ heroku borealis-pg:tunnel --app sushi --port 54321

  $ heroku borealis-pg:tunnel --app sushi --addon BOREALIS_PG_MAROON

  $ heroku borealis-pg:tunnel --addon borealis-pg-hex-12345 --write-access

See code: src/commands/borealis-pg/tunnel.ts

heroku borealis-pg:upgrade:cancel

Cancel a PostgreSQL version upgrade of a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:upgrade:cancel [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Cancel a PostgreSQL version upgrade of a Borealis Isolated Postgres add-on

  Run this command to cancel a PostgreSQL version upgrade that was started with
  the borealis-pg:upgrade:execute command. Can only be used when an upgrade is
  still in progress.

  There is no disruption to an add-on database's availability when this command
  is executed. It simply discards the logical replica that was created to perform
  the upgrade behind the scenes.

EXAMPLES
  $ heroku borealis-pg:upgrade:cancel --app sushi

See code: src/commands/borealis-pg/upgrade/cancel.ts

heroku borealis-pg:upgrade:execute

Upgrade the PostgreSQL version of a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:upgrade:execute [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Upgrade the PostgreSQL version of a Borealis Isolated Postgres add-on

  Initiates an upgrade to the next major version of PostgreSQL. Upgrades are
  performed asynchronously and may take well over an hour to complete. The
  system sends an email at the start and end of the upgrade process to all team
  members and collaborators with access to the add-on.

  Once the upgrade process has finished, the add-on database can't be rolled back
  to the previous major version. It is generally a good idea to test an upgrade
  on a clone that was created with the borealis-pg:restore:execute command before
  upgrading a production add-on database.

  The add-on database will remain online and usable throughout most of the
  upgrade process, with some limitations. Check the documentation at
  https://devcenter.heroku.com/articles/borealis-pg#postgresql-version-upgrades
  for details.

EXAMPLES
  $ heroku borealis-pg:upgrade:execute --app sushi

See code: src/commands/borealis-pg/upgrade/execute.ts

heroku borealis-pg:upgrade:info

Show PostgreSQL version upgrade info for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:upgrade:info [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Show PostgreSQL version upgrade info for a Borealis Isolated Postgres add-on

  Indicates whether an add-on can be upgraded to a newer PostgreSQL major
  version, and if so, to which version. If an upgrade is available, you can use
  the borealis-pg:restore:execute command to begin.

EXAMPLES
  $ heroku borealis-pg:upgrade:info --app sushi

See code: src/commands/borealis-pg/upgrade/info.ts

heroku borealis-pg:users

List database user roles for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:users [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  List database user roles for a Borealis Isolated Postgres add-on

  Note that this command's output only includes active add-on database user
  roles. The Heroku application's database user roles are always present.
  Personal read-only and read/write database user roles are automatically
  created or reactivated for any user that has permission to access any app the
  add-on is attached to when that user runs one of the borealis-pg:psql or
  borealis-pg:tunnel commands (or borealis-pg:run with the --personal-user
  option). All personal database user roles are automatically deactivated when
  the add-on's database user credentials are reset (for example, via the
  borealis-pg:users:reset command).

See code: src/commands/borealis-pg/users/index.ts

heroku borealis-pg:users:reset

Reset all database credentials for a Borealis Isolated Postgres add-on

USAGE
  $ heroku borealis-pg:users:reset [-o <value>] [-a <value>]

FLAGS
  -a, --app=<value>    app to which the add-on is attached
  -o, --addon=<value>  name or ID of an add-on or one of its attachments

DESCRIPTION
  Reset all database credentials for a Borealis Isolated Postgres add-on

  The Heroku application's database user roles will be assigned new, random
  usernames and passwords and the application's config vars will be updated
  imminently with the new credentials. To ensure there is no application
  downtime, the old application database credentials will continue to remain
  valid for a short time after this operation is completed, after which they
  will be disabled.

  Any active personal database user roles will also be deactivated by this
  operation, which means that anyone that is currently connected to the database
  with a personal user role will be immediately disconnected. Rest assured that
  any tables, indexes, views or other objects that are are owned by a personal
  user role will not be affected (the user roles and the objects they own will
  continue to exist). A personal user role that has been deactivated will be
  automatically reactivated when the affected user runs one of the
  borealis-pg:psql or borealis-pg:tunnel commands (or borealis-pg:run with the
  --personal-user option).

  Add-on data integrations are unaffected by this operation. To revoke database
  credentials assigned to a data integration, use the
  borealis-pg:integrations:revoke command.

See code: src/commands/borealis-pg/users/reset.ts