Skip to content

[postgres] Clarify relations config requires dbname or database_autodiscovery#23988

Closed
joeykelroy wants to merge 1 commit into
masterfrom
fix/postgres-relations-doc-update
Closed

[postgres] Clarify relations config requires dbname or database_autodiscovery#23988
joeykelroy wants to merge 1 commit into
masterfrom
fix/postgres-relations-doc-update

Conversation

@joeykelroy

Copy link
Copy Markdown
Contributor

Summary

  • The relations parameter description in spec.yaml only mentioned dbname as a requirement, omitting database_autodiscovery as a valid alternative
  • Updated the description to clarify that either dbname (single database) or database_autodiscovery (all databases on the instance) must be configured when using relations
  • Regenerated conf.yaml.example from the updated spec via ddev validate config -s postgres

Test plan

  • Verify conf.yaml.example description for the relations parameter matches the updated spec

…iscovery

The previous description only mentioned `dbname` as a requirement when
using the `relations` parameter, omitting `database_autodiscovery` as a
valid alternative for collecting relation metrics across all databases.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@datadog-datadog-prod-us1

Copy link
Copy Markdown
Contributor

Pipelines

Fix all issues with BitsAI

⚠️ Warnings

🚦 1 Pipeline job failed

Check PR | run / Check PR changelog   View in Datadog   GitHub Actions

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 431012c | Docs | Datadog PR Page | Give us feedback!

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 431012c41c

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

# dbstrict: false

## @param ignore_databases - list of strings - optional - default: ['template0', 'template1', 'rdsadmin', 'azure_maintenance', 'cloudsqladmin', 'alloydbadmin', 'alloydbmetadata']
## @param ignore_databases - list of strings - optional

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve documented list defaults

This generated example now drops the - default: [...] suffix even though instance_ignore_databases() still applies the template/admin database exclusions when the option is omitted; the same regeneration also removes default annotations for several other list-valued options. In the public example this makes these values look like examples rather than effective defaults, so users can misconfigure monitoring by assuming omitted ignore_databases has no exclusions. Please regenerate with the expected defaults preserved or update the spec so the example continues to show the runtime default.

Useful? React with 👍 / 👎.

@joeykelroy joeykelroy closed this Jun 9, 2026
@joeykelroy joeykelroy deleted the fix/postgres-relations-doc-update branch June 9, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant