db
db schema-catalog
Read a database's schema catalog
Connects to the upstream database read-only and returns its user relations (tables and views) and columns. Powers table/column autocomplete and view-aware warnings in the policy editor — relation kind distinguishes a view (whose masking/row-filters apply to the view itself, not its base tables) from a base table, and a per-column is_binary flag flags columns that mask to NULL. System schemas are excluded; nothing is persisted.
Usage
pgbeam db schema-catalog <id>Options
| Option | Description | Required | Default |
|---|---|---|---|
<id> | Yes | - |
Global options
All global options (--token, --profile,
--project, --org, --json, --no-color, --no-trunc, --debug) are
also available on this command.
Examples
# Read a database's schema catalog
pgbeam db schema-catalog
# Output as JSON
pgbeam db schema-catalog --jsonOutput
Renders a human-readable table or detail view by default; pass --json for the raw API response.