@heroku-cli/plugin-pg-v5

{ "version": "8.11.2", "commands": { "pg:backups": { "id": "pg:backups", "description": "list database backups\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "verbose": { "name": "verbose", "type": "boolean", "char": "v", "hidden": true, "required": false, "allowNo": false }, "confirm": { "name": "confirm", "type": "option", "char": "c", "hidden": true, "required": false }, "output": { "name": "output", "type": "option", "char": "o", "hidden": true, "required": false }, "wait-interval": { "name": "wait-interval", "type": "option", "hidden": true, "required": false }, "at": { "name": "at", "type": "option", "hidden": true, "required": false }, "quiet": { "name": "quiet", "type": "boolean", "char": "q", "hidden": true, "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [] }, "pg:backups:cancel": { "id": "pg:backups:cancel", "description": "cancel an in-progress backup or restore (default newest)\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:backups:capture": { "id": "pg:backups:capture", "description": "capture a new backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "wait-interval": { "name": "wait-interval", "type": "option", "required": false }, "snapshot": { "name": "snapshot", "type": "boolean", "hidden": true, "required": false, "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:backups:delete": { "id": "pg:backups:delete", "description": "delete a backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": true } ] }, "pg:backups:download": { "id": "pg:backups:download", "description": "downloads database backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "output": { "name": "output", "type": "option", "char": "o", "description": "location to download to. Defaults to latest.dump", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:backups:info": { "id": "pg:backups:info", "description": "get information about a specific backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:backups:restore": { "id": "pg:backups:restore", "description": "restore a backup (default latest) to a database\ndefaults to saving the latest database to DATABASE_URL", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "wait-interval": { "name": "wait-interval", "type": "option", "required": false }, "extensions": { "name": "extensions", "type": "option", "char": "e", "description": "comma-separated list of extensions to pre-install in the public schema", "required": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "required": false, "allowNo": false }, "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup", "required": false }, { "name": "database", "required": false } ] }, "pg:backups:schedule": { "id": "pg:backups:schedule", "description": "schedule daily backups for given database\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "at": { "name": "at", "type": "option", "description": "at a specific (24h) hour in the given timezone. Defaults to UTC. --at '[HOUR]:00 [TIMEZONE]'", "required": true }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:backups:schedules": { "id": "pg:backups:schedules", "description": "list backup schedule\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [] }, "pg:backups:unschedule": { "id": "pg:backups:unschedule", "description": "stop daily backups\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:backups:url": { "id": "pg:backups:url", "description": "get secret but publicly accessible URL of a backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "quiet": { "name": "quiet", "type": "boolean", "char": "q", "hidden": true, "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:backups:public-url": { "id": "pg:backups:public-url", "description": "get secret but publicly accessible URL of a backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "quiet": { "name": "quiet", "type": "boolean", "char": "q", "hidden": true, "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:backups:publicurl": { "id": "pg:backups:publicurl", "description": "get secret but publicly accessible URL of a backup\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "quiet": { "name": "quiet", "type": "boolean", "char": "q", "hidden": true, "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "backup_id", "required": false } ] }, "pg:bloat": { "id": "pg:bloat", "description": "show table and index bloat in your database ordered by most wasteful\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:blocking": { "id": "pg:blocking", "description": "display queries holding locks other queries are waiting to be released\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:connection-pooling:attach": { "id": "pg:connection-pooling:attach", "description": "add an attachment to a database using connection pooling\nExample:\n\n heroku pg:connection-pooling:attach postgresql-something-12345\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "as": { "name": "as", "type": "option", "description": "name for add-on attachment", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:copy": { "id": "pg:copy", "description": "copy all data from source db to target\nat least one of the databases must be a Heroku PostgreSQL DB", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "wait-interval": { "name": "wait-interval", "type": "option", "required": false }, "verbose": { "name": "verbose", "type": "boolean", "required": false, "allowNo": false }, "confirm": { "name": "confirm", "type": "option", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "source", "required": true }, { "name": "target", "required": true } ] }, "pg:credentials": { "id": "pg:credentials", "description": "show information on credentials in the database\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:credentials:create": { "id": "pg:credentials:create", "description": "create credential within database\nExample:\n\n heroku pg:credentials:create postgresql-something-12345 --name new-cred-name\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "name of the new credential within the database", "required": true }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:credentials:destroy": { "id": "pg:credentials:destroy", "description": "destroy credential within database\nExample:\n\n heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "unique identifier for the credential", "required": true }, "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:credentials:repair-default": { "id": "pg:credentials:repair-default", "description": "repair the permissions of the default credential within database\nExample:\n\n heroku pg:credentials:repair-default postgresql-something-12345\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:credentials:rotate": { "id": "pg:credentials:rotate", "description": "rotate the database credentials\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "which credential to rotate (default credentials if not specified)", "required": false }, "all": { "name": "all", "type": "boolean", "description": "rotate all credentials", "required": false, "allowNo": false }, "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "force": { "name": "force", "type": "boolean", "description": "forces rotating the targeted credentials", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:credentials:url": { "id": "pg:credentials:url", "description": "show information on a database credential\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "name": { "name": "name", "type": "option", "char": "n", "description": "which credential to show (default credentials if not specified)", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:diagnose": { "id": "pg:diagnose", "description": "run or view diagnostics report\n\ndefaults to DATABASE_URL database if no DATABASE is specified\nif REPORT_ID is specified instead, a previous report is displayed\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "json": { "name": "json", "type": "boolean", "description": "format output as JSON", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "DATABASE|REPORT_ID", "required": false } ] }, "pg": { "id": "pg", "description": "show database information\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:info": { "id": "pg:info", "description": "show database information\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:kill": { "id": "pg:kill", "description": "kill a query\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "force": { "name": "force", "type": "boolean", "char": "f", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "pid", "required": true }, { "name": "database", "required": false } ] }, "pg:killall": { "id": "pg:killall", "description": "terminates all connections for all credentials\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:links": { "id": "pg:links", "description": "lists all databases and information on link\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:links:create": { "id": "pg:links:create", "description": "create a link between data stores\nExample:\n\n heroku pg:links:create HEROKU_REDIS_RED HEROKU_POSTGRESQL_CERULEAN", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "as": { "name": "as", "type": "option", "description": "name of link to create", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "remote", "required": true }, { "name": "database", "required": true } ] }, "pg:links:destroy": { "id": "pg:links:destroy", "description": "destroys a link between data stores\nExample:\n\n heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": true }, { "name": "link", "required": true } ] }, "pg:locks": { "id": "pg:locks", "description": "display queries with active locks\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "truncate": { "name": "truncate", "type": "boolean", "char": "t", "description": "truncates queries to 40 characters", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:maintenance": { "id": "pg:maintenance", "description": "show current maintenance information\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:maintenance:run": { "id": "pg:maintenance:run", "description": "start maintenance\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "force": { "name": "force", "type": "boolean", "char": "f", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:maintenance:window": { "id": "pg:maintenance:window", "description": "set weekly maintenance window\nAll times are in UTC.\n\nExample:\n\n heroku pg:maintenance:window postgres-slippery-100 \"Sunday 06:00\"", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": true }, { "name": "window", "required": true } ] }, "pg:outliers": { "id": "pg:outliers", "description": "show 10 queries that have longest execution time in aggregate\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "reset": { "name": "reset", "type": "boolean", "description": "resets statistics gathered by pg_stat_statements", "required": false, "allowNo": false }, "truncate": { "name": "truncate", "type": "boolean", "char": "t", "description": "truncate queries to 40 characters", "required": false, "allowNo": false }, "num": { "name": "num", "type": "option", "char": "n", "description": "the number of queries to display (default: 10)", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:promote": { "id": "pg:promote", "description": "sets DATABASE as your DATABASE_URL\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "force": { "name": "force", "type": "boolean", "char": "f", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": true } ] }, "pg:ps": { "id": "pg:ps", "description": "view active queries with execution time\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "verbose": { "name": "verbose", "type": "boolean", "char": "v", "required": false, "allowNo": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:psql": { "id": "pg:psql", "description": "open a psql shell to the database\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "command": { "name": "command", "type": "option", "char": "c", "description": "SQL command to run", "required": false }, "file": { "name": "file", "type": "option", "char": "f", "description": "SQL file to run", "required": false }, "credential": { "name": "credential", "type": "option", "description": "credential to use", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "psql": { "id": "psql", "description": "open a psql shell to the database\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "command": { "name": "command", "type": "option", "char": "c", "description": "SQL command to run", "required": false }, "file": { "name": "file", "type": "option", "char": "f", "description": "SQL file to run", "required": false }, "credential": { "name": "credential", "type": "option", "description": "credential to use", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:push": { "id": "pg:push", "description": "push local or remote into Heroku database\nPush from SOURCE into TARGET. TARGET must be empty.\n\nTo empty a Heroku database for push run `heroku pg:reset`\n\nSOURCE must be either the name of a database existing on your localhost or the\nfully qualified URL of a remote database.\n\nExamples:\n\n # push mylocaldb into a Heroku DB named postgresql-swimmingly-100\n $ heroku pg:push mylocaldb postgresql-swimmingly-100\n\n # push remote DB at postgres://myhost/mydb into a Heroku DB named postgresql-swimmingly-100\n $ heroku pg:push postgres://myhost/mydb postgresql-swimmingly-100\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "exclude-table-data": { "name": "exclude-table-data", "type": "option", "description": "tables for which data should be excluded (use ';' to split multiple names)", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "source", "required": true }, { "name": "target", "required": true } ] }, "pg:pull": { "id": "pg:pull", "description": "pull Heroku database into local or remote database\nPull from SOURCE into TARGET.\n\nTARGET must be one of:\n * a database name (i.e. on a local PostgreSQL server) => TARGET must not exist and will be created\n * a fully qualified URL to a local PostgreSQL server => TARGET must not exist and will be created\n * a fully qualified URL to a remote PostgreSQL server => TARGET must exist and be empty\n\nTo delete a local database run `dropdb TARGET`\nTo create an empty remote database, run `createdb` with connection command-line options (run `createdb --help` for details).\n\nExamples:\n\n # pull Heroku DB named postgresql-swimmingly-100 into local DB mylocaldb that must not exist\n $ heroku pg:pull postgresql-swimmingly-100 mylocaldb --app sushi\n\n # pull Heroku DB named postgresql-swimmingly-100 into empty remote DB at postgres://myhost/mydb\n $ heroku pg:pull postgresql-swimmingly-100 postgres://myhost/mydb --app sushi\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "exclude-table-data": { "name": "exclude-table-data", "type": "option", "description": "tables for which data should be excluded (use ';' to split multiple names)", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "source", "required": true }, { "name": "target", "required": true } ] }, "pg:repoint": { "id": "pg:repoint", "description": "changes which leader a follower is following\nExample:\n\n heroku pg:repoint postgresql-transparent-56874 --follow postgresql-lucid-59103 -a woodstock-production\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": true, "aliases": [], "flags": { "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "follow": { "name": "follow", "type": "option", "description": "leader database to follow", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:reset": { "id": "pg:reset", "description": "delete all data in DATABASE\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "extensions": { "name": "extensions", "type": "option", "char": "e", "description": "comma-separated list of extensions to pre-install in the public schema", "required": false }, "confirm": { "name": "confirm", "type": "option", "char": "c", "required": false }, "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:settings": { "id": "pg:settings", "description": "show your current database settings\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "database", "required": false } ] }, "pg:settings:auto-explain": { "id": "pg:settings:auto-explain", "description": "Automatically log execution plans of queries without running EXPLAIN by hand.\nThe auto_explain module is loaded at session-time so existing connections will not be logged.\nRestart your Heroku app and/or restart existing connections for logging to start taking place.", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "value", "required": false }, { "name": "database", "required": false } ] }, "pg:settings:auto-explain:log-analyze": { "id": "pg:settings:auto-explain:log-analyze", "description": "Shows actual run times on the execution plan.\nThis is equivalent to calling EXPLAIN ANALYZE.\n\nWARNING: EXPLAIN ANALYZE will be run on ALL queries, not just logged queries. This can cause significant performance impacts to your database and should be used with caution.\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "value", "required": false }, { "name": "database", "required": false } ] }, "pg:settings:auto-explain:log-buffers": { "id": "pg:settings:auto-explain:log-buffers", "description": "Includes buffer usage statistics when execution plans are logged.\nThis is equivalent to calling EXPLAIN BUFFERS and can only be used in conjunction with pg:settings:auto-explain:log-analyze turned on.", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "value", "required": false }, { "name": "database", "required": false } ] }, "pg:settings:auto-explain:log-min-duration": { "id": "pg:settings:auto-explain:log-min-duration", "description": "Sets the minimum execution time in milliseconds for a statement's plan to be logged.\nSetting this value to 0 will log all queries. Setting this value to -1 will disable logging entirely.\n\nWARNING: Setting a low value may have performance impacts on your database as well as generate a large volume of logs.", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "name": "remote", "type": "option", "char": "r", "description": "git remote of app to use" } }, "args": [ { "name": "value", "required": false }, { "name": "database", "required": false } ] }, "pg:settings:auto-explain:log-nested-statements": { "id": "pg:settings:auto-explain:log-nested-statements", "description": "Nested statements are included in the execution plan's log.\n", "pluginName": "@heroku-cli/plugin-pg-v5", "pluginType": "core", "hidden": false, "aliases": [], "flags": { "app": { "name": "app", "type": "option", "char": "a", "description": "app to run command against", "required": true }, "remote": { "