PgBeam
PgBeam Docs
db

db test

Test database connection

Attempts to connect to the upstream database using the stored credentials and returns the result.

Usage

pgbeam db test <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

# Test database connection
pgbeam db test

# Output as JSON
pgbeam db test --json

Output

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

On this page