Skip to main content

DESCRIBE FLOW

Description​

Show the configurations and status for a specified Flow.

Note that the SQL statement does not end with ;

Syntax​

DESCRIBE FLOW `<name>`

Sample response

Examples​

DESCRIBE FLOW `ingestion_flow_1`

Required parameters​

  • <name>: Specify the name of the Flow to describe.

Enumerating sources and topics across all Flows​

To programmatically list the source (and, for Kafka, the topic) each Flow is consuming, combine SHOW FLOWS with DESCRIBE FLOW:

SHOW FLOWS

Then for each returned Flow name:

DESCRIBE FLOW `<name>`

The response includes the source configuration — for Kafka sources, the topic name appears in the source's WITH properties.

Duplicate flow names

DESCRIBE FLOW resolves by name only. If multiple Flows in the same project share a name (different destination tables, same flow name), DESCRIBE FLOW returns an error rather than disambiguating. Rename one of the Flows so each name is unique within the project.