📣
TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

STREAM_STATUS



Provides information about the status of a specified stream, yielding a single-column result (has_data) that can take on values of true or false:

  • true: Indicates that the stream might contain change data capture records.
  • false: Indicates that the stream currently does not contain any change data capture records.

Syntax

SELECT * FROM STREAM_STATUS('<database_name>.<stream_name>'); -- OR SELECT * FROM STREAM_STATUS('<stream_name>'); -- Uses current database

Examples

-- Create a table 't' with a column 'c' CREATE TABLE t (c int); -- Create a stream 's' on the table 't' CREATE STREAM s ON TABLE t; -- Check the initial status of the stream 's' SELECT * FROM STREAM_STATUS('s'); -- The result should be 'false' indicating no change data capture records initially ┌──────────┐ │ has_data │ ├──────────┤ │ false │ └──────────┘ -- Insert a value into the table 't' INSERT INTO t VALUES (1); -- Check the updated status of the stream 's' after the insertion SELECT * FROM STREAM_STATUS('s'); -- The result should now be 'true' indicating the presence of change data capture records ┌──────────┐ │ has_data │ ├──────────┤ │ true │ └──────────┘ -- Example with database name specified SELECT * FROM STREAM_STATUS('mydb.s');

Was this page helpful?