annotations
annotations delete
Delete a schema annotation
Removes a single annotation identified by its natural key. Omit column_name to delete a table-level annotation, and omit schema_name to match the unqualified form.
Usage
pgbeam annotations delete [flags]Options
| Option | Description | Required | Default |
|---|---|---|---|
--table-name <value> | Relation (table or view) the annotation describes. | Yes | - |
--schema-name <value> | Optional schema. Omit to match the unqualified form. | No | - |
--column-name <value> | Optional column. Omit to delete a table-level annotation. | No | - |
--yes, -y | Skip the confirmation prompt (useful for scripts and CI/CD) | No | - |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --no-trunc, --debug) are
also available on this command.
Examples
# Delete a schema annotation
pgbeam annotations delete
# Output as JSON
pgbeam annotations delete --jsonOutput
Renders a human-readable table or detail view by default; pass --json for the raw API response.