Comment fields

In PostgreSQL a role comment lives as plain text. But we can store an JSON formatted string there. Comment fields defines the form that helps editing json content.

Comment fields settings

The field list

The list starts empty — which keys a role comment carries is your convention, not something the app can guess — and it may be emptied again at any time. Each entry is a key (the JSON key, a bare identifier) and a label (what the form shows). Drag the handle to reorder; removes an entry; Add field… appends one.

Rules:

• Configured fields found in the comment always render, even when the key is absent from the comment.
• Keys not found in the comments but missing from the list still render, labelled by their raw key.
• Values that aren’t strings (number, boolean, array, object) render read-only, so their type survives a round trip. Edit them in the Raw view.
• Leaving the label blank falls back to the key.

Tip

Each configured key also becomes a placeholder — ${{key}} — usable in the create_role and set_comment call templates or role details feature.

Preferred comment view

Sets which mode the comment editor opens in — Fields or Raw — in the role form and in the Comments dialog alike. It defaults to Raw.

Note

It is a preference, not a rule. A comment that is not JSON has no fields to show, so it always opens in Raw whichever you pick.

See Altering the comment for the editor itself.

Where else these keys appear

Beyond the role form, a comment key can be shown in the role search results — see Role Details.

Tip

That list is not limited to the keys configured here — it can address any key in the comment.