show-sinks.md 1.5 KB


title: "SHOW SINKS" description: "SHOW SINKS returns a list of all sinks available in Materialize." menu: main:

parent: commands

aliases:

- /sql/show-sink

SHOW SINKS returns a list of all sinks available in Materialize.

Syntax

SHOW SINKS [ FROM <schema_name> ] [ IN CLUSTER <cluster_name> ]

Details

Output format

SHOW SINKS's output is a table, with this structure:

name  | type | cluster
------+------+--------
...   | ...  | ...
Option Description
FROM If specified, only show sinks from the specified schema. Defaults to first resolvable schema in the search path. For available schemas, see SHOW SCHEMAS.
IN CLUSTER If specified, only show sinks from the specified cluster. For available clusters, see SHOW CLUSTERS.
Field Meaning
name The name of the sink.
type The type of the sink: currently only kafka is supported.
cluster The cluster the sink is associated with.

Examples

SHOW SINKS;
name          | type  | cluster
--------------+-------+--------
my_sink       | kafka | c1
my_other_sink | kafka | c2
SHOW SINKS IN CLUSTER c1;
name    | type  | cluster
--------+-------+--------
my_sink | kafka | c1

Related pages