Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.risingwave.com/llms.txt

Use this file to discover all available pages before exploring further.

Syntax

SHOW CONNECTIONS [ FROM schema_name ] [ LIKE_expression ];

Parameters

Parameter or clauseDescription
schema_nameThe schema of the connections to be listed. If not specified, connections from all schemas in the current schema search_path will be listed.
LIKE_expressionFilters the output based on names by applying pattern matching. See details in LIKE pattern matching expressions.

Example

Here is an example of what you might see. Any sources or sinks that reference the connection will also be listed.
SHOW CONNECTIONS;
Name                   | Type        | Properties
-----------------------+-------------+-----------------------------------------
public.connection_name | privatelink | provider: aws
                       |             | service_name: com.amazonaws.xyz.us-east-1.abc-xyz-0000
                       |             | endpoint_id: xyz-0000
                       |             | availability_zones: ["use1-az6", "use1-az4"]
                       |             | sources: ["tcp_metrics"]
                       |             | sinks: ["sink1"]
Starting from v2.7.0, the Name column in the output includes the schema name as a prefix (e.g., public.connection_name). This helps distinguish connections with the same name in different schemas when querying across multiple schemas in the search path.

CREATE CONNECTION

Create a connection