[eablack]

Summary

Adds data.databaseSettings.{getAll, get, update} so the v12 CLI's pg:settings commands can drop their own database resolution and their direct calls to /postgres/v0/databases/{id}/config.

• getAll(appIdentity, databaseIdentity?, options?) returns {addon, settings}.
• get(appIdentity, key, databaseIdentity?, options?) returns {addon, setting}.
• update(appIdentity, key, value, databaseIdentity?, options?) sends only {[key]: value} and returns {addon, setting}.

Each one resolves the database through resolvePgDatabase (DATABASE_URL by default) and rejects Essential-tier databases with EssentialDatabaseNotSupportedError before calling the config endpoint. get and update throw a new UnknownSettingError (id unknown_database_setting) when the response doesn't include the key. The endpoint only returns the keys the database's tier supports.

Notes:

• It's a new databaseSettings resource, not database.settings, because extensions add methods to a resource and can't add nested objects.
• PostgresDatabaseUpdateConfigOpts in @heroku/types lists only 3 of the keys the endpoint accepts, so update casts the body. The key and value types come from PostgresDatabaseConfigResult, which lists every key.

Type of Change

Breaking Changes (major semver update)

• Add a ! after your change type to denote a change that breaks current behavior

Feature Additions (minor semver update)

• feat: Introduces a new feature to the codebase

Patch Updates (patch semver update)

• fix: Bug fix
• deps: Dependency upgrade
• revert: Revert a previous commit
• chore: Change that does not affect production code
• refactor: Refactoring existing code without changing behavior
• test: Add/update/remove tests

Testing

Notes:
The CLI side is in heroku/cli on branch eb/W-23389002/pg-settings-sdk. You need a non-Essential Heroku Postgres database to try it.

Steps:

1. npm run build, then in a script: const sdk = new HerokuSDK({extensions: [databaseSettingsExtensions]}).
2. await sdk.data.databaseSettings.getAll('<app>') returns the DATABASE_URL database's add-on and every setting.
3. await sdk.data.databaseSettings.get('<app>', 'log_lock_waits') returns that one setting.
4. await sdk.data.databaseSettings.update('<app>', 'log_lock_waits', true) returns the updated setting. Set it back afterward.
5. Against an Essential-tier database, each call throws EssentialDatabaseNotSupportedError without calling the config endpoint.

Related Issues

GUS work item: W-23389002