heroku 10.13.2 → 11.0.0-alpha.10

package/lib/oldCommands/pg/reset.js

@@ -0,0 +1,49 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import confirmCommand from '../../lib/confirmCommand'
+import pgHost from '../../lib/pg/host'
+import {getAddon} from '../../lib/pg/fetcher'
+import heredoc from 'tsheredoc'
+import {nls} from '../../nls'
+
+export default class Reset extends Command {
+  static topic = 'pg';
+  static description = 'delete all data in DATABASE';
+  static flags = {
+    extensions: flags.string({char: 'e', description: 'comma-separated list of extensions to pre-install in the public schema'}),
+    confirm: flags.string({char: 'c'}),
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  };
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  };
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Reset)
+    const {app, confirm, extensions} = flags
+    const db = await getAddon(this.heroku, app, args.database)
+    let extensionsArray
+    if (extensions) {
+      extensionsArray = extensions.split(',')
+        .map(ext => ext.trim()
+          .toLowerCase())
+        .sort()
+    }
+
+    await confirmCommand(app, confirm, heredoc(`
+      Destructive action
+      ${color.addon(db.name)} will lose all of its data
+    `))
+    ux.action.start(`Resetting ${color.addon(db.name)}`)
+    await this.heroku.put(`/client/v11/databases/${db.id}/reset`, {
+      body: {extensions: extensionsArray}, hostname: pgHost(),
+    })
+    ux.action.stop()
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-analyze.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-analyze.js

@@ -0,0 +1,37 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand, booleanConverter, BooleanAsString} from '../../../../lib/pg/setter'
+import {SettingKey, Setting} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class LogAnalyze extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    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.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if execution plans get logged'}),
+  }
+
+  protected settingKey = 'auto_explain.log_analyze' as SettingKey
+
+  protected convertValue(val: BooleanAsString): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting<boolean>) {
+    if (setting.value) {
+      return 'EXPLAIN ANALYZE execution plans will be logged.'
+    }
+
+    return 'EXPLAIN ANALYZE execution plans will not be logged.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-buffers.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-buffers.js

@@ -0,0 +1,35 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {BooleanAsString, PGSettingsCommand, booleanConverter} from '../../../../lib/pg/setter'
+import {Setting, SettingKey} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class LogBuffersWaits extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    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.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if the database has buffer statistics enabled'}),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_buffers'
+
+  protected convertValue(val: BooleanAsString): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting<boolean>) {
+    if (setting.value) {
+      return 'Buffer statistics have been enabled for auto_explain.'
+    }
+
+    return 'Buffer statistics have been disabled for auto_explain.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-format.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-format.js

@@ -0,0 +1,30 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import {PGSettingsCommand} from '../../../../lib/pg/setter'
+import {Setting, SettingKey} from '../../../../lib/pg/types'
+import heredoc from 'tsheredoc'
+import {nls} from '../../../../nls'
+
+export default class LogFormat extends PGSettingsCommand {
+  static description = heredoc(`
+    selects the EXPLAIN output format to be used
+    The allowed values are text, xml, json, and yaml. The default is text.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({options: ['text', 'json', 'yaml', 'xml'], description: 'format of the log output\n<options: text|json|yaml|xml>'}),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_format'
+
+  protected explain(setting: Setting<string>) {
+    return `Auto explain log output will log in ${setting.value} format.`
+  }
+
+  protected convertValue(val: string): string {
+    return val
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-min-duration.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-min-duration.js

@@ -0,0 +1,39 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand, numericConverter} from '../../../../lib/pg/setter'
+import {Setting, SettingKey} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class LogMinDuration extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    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.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'minimum duration in milliseconds for queries before logging execution plans. A value of -1 disables it. A value of 0 logs all query execution plans.'}),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_min_duration'
+
+  protected convertValue(val: string): number {
+    return numericConverter(val)
+  }
+
+  protected explain(setting: Setting<number>) {
+    if (setting.value === -1) {
+      return 'Execution plan logging has been disabled.'
+    }
+
+    if (setting.value === 0) {
+      return 'All queries will have their execution plans logged.'
+    }
+
+    return `All execution plans will be logged for queries taking up to ${setting.value} milliseconds or more.`
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-nested-statements.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-nested-statements.js

@@ -0,0 +1,30 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import {type BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class LogNestedStatements extends PGSettingsCommand {
+  static description = "Nested statements are included in the execution plan's log."
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if execution plan logs include nested statements'}),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_nested_statements'
+
+  protected convertValue(val: unknown): boolean {
+    return booleanConverter(val as BooleanAsString)
+  }
+
+  protected explain(setting: Setting<unknown>) {
+    if (setting.value) {
+      return 'Nested statements will be included in execution plan logs.'
+    }
+
+    return 'Only top-level execution plans will be included in logs.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-triggers.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-triggers.js

@@ -0,0 +1,35 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand, booleanConverter, BooleanAsString} from '../../../../lib/pg/setter'
+import {SettingKey, Setting} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class LogTriggers extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    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.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if the database has trigger execution statistics enabled'}),
+  }
+
+  protected settingKey = 'auto_explain.log_triggers' as SettingKey
+
+  protected convertValue(val: BooleanAsString): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting<boolean>) {
+    if (setting.value) {
+      return 'Trigger execution statistics have been enabled for auto-explain.'
+    }
+
+    return 'Trigger execution statistics have been disabled for auto-explain.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain/log-verbose.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain/log-verbose.js

@@ -0,0 +1,40 @@
+export {};
+/*
+import {flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {type BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../../lib/pg/types'
+import {nls} from '../../../../nls'
+
+export default class AutoExplainLogVerbose extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(
+    `Include verbose details in execution plans.
+    This is equivalent to calling EXPLAIN VERBOSE.`)
+
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if the database has verbose execution plan logging enabled'}),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_verbose'
+
+  protected explain(setting: Setting<unknown>) {
+    if (setting.value) {
+      return 'Verbose execution plan logging has been enabled for auto_explain.'
+    }
+
+    return 'Verbose execution plan logging has been disabled for auto_explain.'
+  }
+
+  protected convertValue(val: unknown): boolean {
+    return booleanConverter(val as BooleanAsString)
+  }
+}
+*/

package/lib/oldCommands/pg/settings/auto-explain.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/auto-explain.js

@@ -0,0 +1,45 @@
+export {};
+/*
+import {flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../lib/pg/setter'
+import {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+// ref: https://www.postgresql.org/docs/current/auto-explain.html
+export default class AutoExplain extends PGSettingsCommand {
+  static topic = 'pg';
+  static description = heredoc(`
+  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.
+  `)
+
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if execution plans of queries will be logged for future connections'}),
+  }
+
+  static strict = false
+
+  protected settingKey: SettingKey = 'auto_explain'
+
+  protected convertValue(val: BooleanAsString): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting<boolean>): string {
+    if (setting.value) {
+      return 'Execution plans of queries will be logged for future connections.'
+    }
+
+    return 'Execution plans of queries will not be logged for future connections.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/data-connector-details-logs.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/data-connector-details-logs.js

@@ -0,0 +1,40 @@
+export {};
+/*
+import {flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {type BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class DataConnectorDetailsLogs extends PGSettingsCommand {
+  static aliases = ['pg:settings:explain-data-connector-details']
+  static description = heredoc(`
+  displays stats on replication slots on your database, the default value is "off"
+  `)
+
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if data replication slot details get logged'}),
+  }
+
+  protected settingKey:SettingKey = 'data_connector_details_logs'
+
+  protected convertValue(val: BooleanAsString): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting<boolean>): string {
+    if (setting?.value) {
+      return 'Data replication slot details will be logged.'
+    }
+
+    return 'Data replication slot details will no longer be logged.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/index.js

@@ -0,0 +1,41 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {hux} from '@heroku/heroku-cli-util'
+import {SettingKey, SettingsResponse} from '../../../lib/pg/types'
+import {addonResolver} from '../../../lib/addons/resolve'
+import {essentialPlan} from '../../../lib/pg/util'
+import host from '../../../lib/pg/host'
+import {nls} from '../../../nls'
+
+export default class Index extends Command {
+  static topic = 'pg'
+  static description = 'show your current database settings'
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Index)
+    const {app} = flags
+    const {database} = args
+    const db = await addonResolver(this.heroku, app, database || 'DATABASE_URL')
+
+    if (essentialPlan(db)) ux.error('You can’t perform this operation on Essential-tier databases.')
+
+    const {body: settings} = await this.heroku.get<SettingsResponse>(`/postgres/v0/databases/${db.id}/config`, {hostname: host()})
+    hux.styledHeader(db.name)
+    const remapped: Record<string, unknown> = {}
+    Object.keys(settings).forEach(k => {
+      remapped[k.replace(/_/g, '-')] = settings[k as SettingKey].value
+    })
+    hux.styledObject(remapped)
+  }
+}
+*/

package/lib/oldCommands/pg/settings/log-connections.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/log-connections.js

@@ -0,0 +1,40 @@
+export {};
+/*
+import {flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {type BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class LogConnections extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+  Controls whether a log message is produced when a login attempt is made. Default is true.
+  Setting log_connections to false stops emitting log messages for all attempts to login to the database.`)
+
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if database login attempts get logged'}),
+  }
+
+  protected settingKey: SettingKey = 'log_connections'
+
+  protected convertValue(val: unknown): unknown {
+    return booleanConverter(val as BooleanAsString)
+  }
+
+  protected explain(setting: Setting<unknown>): string {
+    if (setting.value) {
+      return 'When login attempts are made, a log message will be emitted in your application\'s logs.'
+    }
+
+    return 'When login attempts are made, no log message will be emitted in your application\'s logs.'
+  }
+}
+*/

package/lib/oldCommands/pg/settings/log-lock-waits.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/log-lock-waits.js

@@ -0,0 +1,36 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {type BooleanAsString, booleanConverter, PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class LogLockWaits extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    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
+    Delays due to lock contention occur when multiple transactions are trying to access the same resource at the same time.
+    Applications and their query patterns should try to avoid changes to many different tables within the same transaction.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'boolean indicating if a message gets logged when a session waits longer than the deadlock_timeout to acquire a lock'}),
+  }
+
+  protected settingKey: SettingKey = 'log_lock_waits'
+
+  protected convertValue(val: unknown): boolean {
+    return booleanConverter(val as BooleanAsString)
+  }
+
+  protected explain(setting: Setting<unknown>) {
+    if (setting.value) {
+      return "When a deadlock is detected, a log message will be emitted in your application's logs."
+    }
+
+    return "When a deadlock is detected, no log message will be emitted in your application's logs."
+  }
+}
+*/

package/lib/oldCommands/pg/settings/log-min-duration-statement.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/log-min-duration-statement.js

@@ -0,0 +1,39 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class LogMinDurationStatement extends PGSettingsCommand {
+  static description = heredoc(`
+    The duration of each completed statement will be logged if the statement completes after the time specified by VALUE.
+    VALUE needs to specified as a whole number, in milliseconds.
+    Setting log_min_duration_statement to zero prints all statement durations and -1 will disable logging statement durations.
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({description: 'milliseconds to wait for a statement to complete before logging it'}),
+  }
+
+  protected settingKey:SettingKey = 'log_min_duration_statement'
+
+  protected convertValue(val: unknown): number {
+    return Number.parseInt(val as string, 10)
+  }
+
+  protected explain(setting: Setting<unknown>) {
+    if (setting.value === -1) {
+      return 'The duration of each completed statement will not be logged.'
+    }
+
+    if (setting.value === 0) {
+      return 'The duration of each completed statement will be logged.'
+    }
+
+    return `The duration of each completed statement will be logged if the statement ran for at least ${setting.value} milliseconds.`
+  }
+}
+*/

package/lib/oldCommands/pg/settings/log-min-error-statement.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/settings/log-min-error-statement.js

@@ -0,0 +1,31 @@
+export {};
+/*
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class LogMinErrorStatement extends PGSettingsCommand {
+  static description = heredoc(`
+    log-min-error-statement controls the logging of SQL statements that cause an error at a specified severity level.
+    This setting is useful to prevent logging SQL queries that might contain sensitive information.
+    Use this setting to prevent logging SQL queries that contain sensitive information. Default is "error".
+  `)
+
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+    value: Args.string({options: ['error', 'log', 'fatal', 'panic']}),
+  }
+
+  protected settingKey: SettingKey = 'log_min_error_statement'
+
+  protected convertValue(val: string): string {
+    return val
+  }
+
+  protected explain(setting: Setting<string>) {
+    return setting.values[setting.value]
+  }
+}
+*/

package/lib/oldCommands/pg/settings/log-statement.d.ts

@@ -0,0 +1 @@
+export {};