Skip to main content

DESC CONNECTION

Introduced or updated: v1.2.965

Describes the details of a specific connection, providing information about its type and configuration.

Syntax​

DESC CONNECTION <connection_name>

Masked Values​

The command masks credentials in storage_params. SHOW CONNECTIONS and SHOW CREATE CONNECTION use the same rules:

OptionHow the value shows
region, role_arn, aws_role_arn, enable_virtual_host_style, disable_list_batch, https, user_name, repo_type, revisionPlain text.
endpoint_url, name_nodePlain text. If the URL has a user name and password, or query parameters, the command masks these parts. For example, https://user:pass@s3.example.com/ shows as https://***:***@s3.example.com/.
All other options, such as access_key_id, secret_access_key, session_token, and account_keyMasked. For example, minioadmin shows as mi***in.

Examples​

CREATE CONNECTION my_s3_conn
STORAGE_TYPE = 's3'
ACCESS_KEY_ID = 'minioadmin'
SECRET_ACCESS_KEY = 'minioadmin'
ENDPOINT_URL = 'http://127.0.0.1:9900/'
REGION = 'us-east-1';

DESC CONNECTION my_s3_conn;

┌────────────┬──────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ name │ storage_type │ storage_params │
├────────────┼──────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ my_s3_conn │ s3 │ access_key_id=mi***in endpoint_url=http://127.0.0.1:9900/ region=us-east-1 secret_access_key=mi***in │
└────────────┴──────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────┘
Try Databend Cloud for FREE

Multimodal, object-storage-native warehouse for BI, vectors, search, and geo.

Snowflake-compatible SQL with automatic scaling.

Sign up and get $200 in credits.

Try it today