PgBeam
PgBeam Docs
db

db scan-pii

Scan a database for likely-PII columns

Connects to the upstream database read-only, inspects information_schema and samples column values against PII heuristics, and returns ranked masking suggestions. Suggestions are advisory — the operator reviews them and applies the ones they want into a policy profile's masking rules. Nothing is auto-applied.

Usage

pgbeam db scan-pii <id>

Options

OptionDescriptionRequiredDefault
<id>Yes-

Global options

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

Examples

# Scan a database for likely-PII columns
pgbeam db scan-pii

# Output as JSON
pgbeam db scan-pii --json

Output

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

On this page