stream-status.md

title	STREAM_STATUS

import FunctionDescription from '@site/src/components/FunctionDescription';

提供指定流的状态信息，返回一个单列结果（has_data），其值可以是 true 或 false：

• true：表示流可能包含变更数据捕获记录。
• false：表示流当前不包含任何变更数据捕获记录。

:::note 结果中的 true（has_data）并不确保一定存在变更数据捕获记录。其他操作，例如执行表压缩操作，也可能导致 true 值，即使实际上没有变更数据捕获记录。 :::

:::note 在任务中使用 STREAM_STATUS 时，引用流时必须包含数据库名称（例如 STREAM_STATUS('mydb.stream_name')）。 :::

语法

SELECT * FROM STREAM_STATUS('<database_name>.<stream_name>');
-- 或
SELECT * FROM STREAM_STATUS('<stream_name>');  -- 使用当前数据库

示例

-- 创建一个带有列 'c' 的表 't'
CREATE TABLE t (c int);

-- 在表 't' 上创建一个流 's'
CREATE STREAM s ON TABLE t;

-- 检查流 's' 的初始状态
SELECT * FROM STREAM_STATUS('s');

-- 结果应为 'false'，表示初始时没有变更数据捕获记录
┌──────────┐
│ has_data │
├──────────┤
│ false    │
└──────────┘

-- 向表 't' 中插入一个值
INSERT INTO t VALUES (1);

-- 插入后检查流 's' 的更新状态
SELECT * FROM STREAM_STATUS('s');

-- 结果现在应为 'true'，表示存在变更数据捕获记录
┌──────────┐
│ has_data │
├──────────┤
│ true     │
└──────────┘

-- 指定数据库名称的示例
SELECT * FROM STREAM_STATUS('mydb.s');