Fix scripting errors

heroku · Apr 15, 2024 · b09df16 · b09df16
1 parent 3959e7f
commit b09df16
Show file tree

Hide file tree

Showing 7 changed files with 221 additions and 42 deletions.
diff --git a/docs/addons.md b/docs/addons.md
@@ -99,6 +99,7 @@ FLAGS
   -c, --confirm=<value>
   -f, --force            allow destruction even if connected to other apps
   -r, --remote=<value>   git remote of app to use
+  --wait                 watch add-on destruction status and exit when complete
 
 DESCRIPTION
   permanently destroy an add-on resource

diff --git a/docs/apps.md b/docs/apps.md
@@ -296,7 +296,7 @@ DESCRIPTION
 
 EXAMPLES
   $ heroku apps:rename --app oldname newname
-  https://newname.herokuapp.com/ | https://git.heroku.com/newname.git
+  https://newname-xxxxxxxxxxxx.herokuapp.com/ | https://git.heroku.com/newname.git
   Git remote heroku updated
 ```
 

diff --git a/docs/pg.md b/docs/pg.md
@@ -44,6 +44,13 @@ manage postgresql databases
 * [`heroku pg:push SOURCE TARGET`](#heroku-pgpush-source-target)
 * [`heroku pg:reset [DATABASE]`](#heroku-pgreset-database)
 * [`heroku pg:settings [DATABASE]`](#heroku-pgsettings-database)
+* [`heroku pg:settings:auto-explain [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explain-value-database)
+* [`heroku pg:settings:auto-explain:log-analyze [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-analyze-value-database)
+* [`heroku pg:settings:auto-explain:log-buffers [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-buffers-value-database)
+* [`heroku pg:settings:auto-explain:log-min-duration [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-min-duration-value-database)
+* [`heroku pg:settings:auto-explain:log-nested-statements [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-nested-statements-value-database)
+* [`heroku pg:settings:auto-explain:log-triggers [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-triggers-value-database)
+* [`heroku pg:settings:auto-explain:log-verbose [VALUE] [DATABASE]`](#heroku-pgsettingsauto-explainlog-verbose-value-database)
 * [`heroku pg:settings:log-lock-waits [VALUE] [DATABASE]`](#heroku-pgsettingslog-lock-waits-value-database)
 * [`heroku pg:settings:log-min-duration-statement [VALUE] [DATABASE]`](#heroku-pgsettingslog-min-duration-statement-value-database)
 * [`heroku pg:settings:log-statement [VALUE] [DATABASE]`](#heroku-pgsettingslog-statement-value-database)
@@ -580,7 +587,7 @@ USAGE
 FLAGS
   -a, --app=<value>     (required) app to run command against
   -r, --remote=<value>  git remote of app to use
-  -t, --truncate        truncates queries to 40 charaters
+  -t, --truncate        truncates queries to 40 characters
 
 DESCRIPTION
   display queries with active locks
@@ -812,6 +819,131 @@ DESCRIPTION
   show your current database settings
 ```
 
+## `heroku pg:settings:auto-explain [VALUE] [DATABASE]`
+
+Automatically log execution plans of queries without running EXPLAIN by hand.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Automatically log execution plans of queries without running EXPLAIN by hand.
+  The auto_explain module is loaded at session-time so existing connections will not be logged.
+  Restart your Heroku app and/or restart existing connections for logging to start taking place.
+```
+
+## `heroku pg:settings:auto-explain:log-analyze [VALUE] [DATABASE]`
+
+Shows actual run times on the execution plan.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-analyze [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Shows actual run times on the execution plan.
+  This is equivalent to calling EXPLAIN ANALYZE.
+
+  WARNING: 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.
+```
+
+## `heroku pg:settings:auto-explain:log-buffers [VALUE] [DATABASE]`
+
+Includes buffer usage statistics when execution plans are logged.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-buffers [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Includes buffer usage statistics when execution plans are logged.
+  This is equivalent to calling EXPLAIN BUFFERS and can only be used in conjunction with
+  pg:settings:auto-explain:log-analyze turned on.
+```
+
+## `heroku pg:settings:auto-explain:log-min-duration [VALUE] [DATABASE]`
+
+Sets the minimum execution time in milliseconds for a statement's plan to be logged.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-min-duration [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Sets the minimum execution time in milliseconds for a statement's plan to be logged.
+  Setting this value to 0 will log all queries. Setting this value to -1 will disable logging entirely.
+
+  WARNING: Setting a low value may have performance impacts on your database as well as generate a large volume of logs.
+```
+
+## `heroku pg:settings:auto-explain:log-nested-statements [VALUE] [DATABASE]`
+
+Nested statements are included in the execution plan's log.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-nested-statements [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Nested statements are included in the execution plan's log.
+```
+
+## `heroku pg:settings:auto-explain:log-triggers [VALUE] [DATABASE]`
+
+Includes trigger execution statistics in execution plan logs.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-triggers [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Includes trigger execution statistics in execution plan logs.
+  This parameter can only be used in conjunction with pg:settings:auto-explain:log-analyze turned on.
+```
+
+## `heroku pg:settings:auto-explain:log-verbose [VALUE] [DATABASE]`
+
+Include verbose details in execution plans.
+
+```
+USAGE
+  $ heroku pg:settings:auto-explain:log-verbose [VALUE] [DATABASE] -a <value> [-r <value>]
+
+FLAGS
+  -a, --app=<value>     (required) app to run command against
+  -r, --remote=<value>  git remote of app to use
+
+DESCRIPTION
+  Include verbose details in execution plans.
+  This is equivalent to calling EXPLAIN VERBOSE.
+```
+
 ## `heroku pg:settings:log-lock-waits [VALUE] [DATABASE]`
 
 Controls whether a log message is produced when a session waits longer than the deadlock_timeout to acquire a lock. deadlock_timeout is set to 1 second

diff --git a/docs/ps.md b/docs/ps.md
@@ -196,7 +196,7 @@ DESCRIPTION
   Called with no arguments shows the current dyno size.
 
   Called with one argument sets the size.
-  Where SIZE is one of free|eco|hobby|standard-1x|standard-2x|performance
+  Where SIZE is one of eco|basic|standard-1x|standard-2x|performance
 
   Called with 1..n TYPE=SIZE arguments sets the quantity per type.
 ```
@@ -317,7 +317,7 @@ DESCRIPTION
   Called with no arguments shows the current dyno size.
 
   Called with one argument sets the size.
-  Where SIZE is one of free|eco|hobby|standard-1x|standard-2x|performance
+  Where SIZE is one of eco|basic|standard-1x|standard-2x|performance
 
   Called with 1..n TYPE=SIZE arguments sets the quantity per type.
 ```

diff --git a/docs/spaces.md b/docs/spaces.md
@@ -132,7 +132,7 @@ DESCRIPTION
   Space CIDRs:       10.0.128.0/20, 10.0.144.0/20
   Unavailable CIDRs: 10.1.0.0/16
 
-  You will use the information provied by this command to establish a peering connection request from your AWS VPC to
+  You will use the information provided by this command to establish a peering connection request from your AWS VPC to
   your private space.
 
   To start the peering process, go into your AWS console for the VPC you would like peered with your Private Space,