Emits metadata for a single connection. Sensitive option values are masked server-side.
DESCRIBE CONNECTION [IF EXISTS] <name>## Overview DESCRIBE CONNECTION emits the non-secret metadata for a single connection: id, name, connection_type, description, last test status and latency, server_version (if recorded), created_at, updated_at, and the count of options keys. The options values themselves are masked server-side for sensitive keys and are not returned in DESCRIBE output. ## Behavior - The HTTP adapter calls GET /connections/{name}. A 404 without IF EXISTS raises an error; with IF EXISTS, a friendly 'does not exist' message is returned. - The count of options keys is included so operators can tell at a glance whether OPTIONS were configured, without leaking individual values. - DESCRIBE never triggers a connection probe. Use TEST CONNECTION to refresh last_test_* fields. ## Access Control Requires the admin role. The Control Plane enforces connections:read on GET /connections/{name}. ## Compatibility DeltaForge extension.
| Name | Type | Description |
|---|---|---|
name | Specifies the name of the connection. | |
if_exists | When true, a missing connection returns a clean 'does not exist' message instead of an error. |
-- Describe a database connection
DESCRIBE CONNECTION prod_pg;-- Describe a cloud storage connection
DESCRIBE CONNECTION raw_data_s3;-- Safe invocation in cleanup scripts
DESCRIBE CONNECTION IF EXISTS maybe_exists;