---
title: "db schema-catalog"
description: "Read a database's schema catalog"
canonical: "https://pgbeam.com/docs/cli/db/schema-catalog"
last-updated: "2026-10-08T10:00:49.000Z"
---

# db schema-catalog

> Read a database's schema catalog

URL: https://pgbeam.com/docs/cli/db/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

## Options

Option

Description

Required

Default

`<id>`

Yes

-

All global options (`--token`, `--profile`,
`--project`, `--org`, `--json`, `--no-color`, `--no-trunc`, `--debug`) are
also available on this command.

## Examples

## Output

Renders a human-readable table or detail view by default; pass `--json` for the raw API response.