Back to Materialize

SHOW SINKS

doc/user/content/sql/show-sinks.md

1231.4 KB
Original Source

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

Syntax

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

Details

Syntax elementDescription
FROM <schema_name>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 <cluster_name>If specified, only show sinks from the specified cluster. For available clusters, see SHOW CLUSTERS.

Output format

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

nofmt
name  | type | cluster
------+------+--------
...   | ...  | ...
FieldMeaning
nameThe name of the sink.
typeThe type of the sink: currently only kafka is supported.
clusterThe cluster the sink is associated with.

Examples

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