DBE_ALERT
DBE_ALERT包的主要功能是在不同会话之间传递数据库的警报信息,包括注册、发送和接收告警。高级功能包DBE_ALERT支持的视图请参见DBE_ALERT.DBE_ALERT_INFO。
- DBE_ALERT包仅支持在主节点使用。
- DBE_ALERT包仅支持在A、B、C、PG兼容性数据库下使用。
- 退出当前会话时会删除该会话所注册的所有警报。
接口介绍
高级功能包DBE_ALERT支持的接口如表1所示。
| 接口名称 | 描述 |
|---|---|
| 为当前会话注册感兴趣的警报。 | |
| 从当前会话的注册列表中删除不感兴趣的警报。 | |
| 从当前会话的注册列表中删除所有警报。 | |
| 为查询警报设置轮询间隔。无实际意义,仅用于兼容。 | |
| 用于发送警报信号。 | |
| 用于等待当前会话注册列表中的任一警报收到警报信号。该函数不受事务回滚影响。 | |
| 用于等待传入警报收到警报信号,警报必须在当前会话注册列表中。该函数不受事务回滚影响。 |
- DBE_ALERT.REGISTER DBE_ALERT.REGISTER原型为:
1 2 3 4
DBE_ALERT.REGISTER( name IN VARCHAR2, cleanup IN BOOLEAN DEFAULT TRUE )RETURNS VOID;
表2 DBE_ALERT.REGISTER接口参数说明 参数
描述
name
警报名称(不区分大小写),最长为30字节,超出长度时报错。GS$为禁止使用的前缀,使用时报错;ORA$为系统保留前缀,建议避免使用,但不作为非法名称校验。
cleanup
无实际意义,仅用于兼容。
调用DBE_ALERT.REGISTER时,所有会话中注册的警报最多为32个,超出时报错。
- DBE_ALERT.REMOVE DBE_ALERT.REMOVE原型为:
1 2 3
DBE_ALERT.REMOVE( name IN VARCHAR2 )RETURNS VOID;
表3 DBE_ALERT.REMOVE接口参数说明 参数
描述
name
警报名称(不区分大小写)。禁止使用以ORA$和GS$作为警报名称的开头。
- DBE_ALERT.REMOVEALL DBE_ALERT.REMOVEALL原型为:
1 2
DBE_ALERT.REMOVEALL( )RETURNS VOID;
- DBE_ALERT.SET_DEFAULTS DBE_ALERT.SET_DEFAULTS原型为:
1 2 3
DBE_ALERT.SET_DEFAULTS( sensitivity IN NUMBER )RETURNS VOID;
表4 DBE_ALERT.SET_DEFAULTS接口参数说明 参数
描述
sensitivity
无实际意义,仅用于兼容。
- DBE_ALERT.SIGNAL
用于发送警报信号。仅当所在事务提交时才会发送信号,若事务回滚则不会产生任何影响。所有注册过此警报的会话均会被通知,并唤醒处于等待状态中的会话。若注册过此警报的会话当前未处于等待状态,将在下次等待信号时将立即收到通知。同一个警报发送的信号可被多个会话同时接收。
DBE_ALERT.SIGNAL原型为:1 2 3 4
DBE_ALERT.SIGNAL( name IN VARCHAR2, message IN VARCHAR2 )RETURNS VOID;
表5 DBE_ALERT.SIGNAL接口参数说明 参数
描述
name
警报名称(不区分大小写)。禁止使用以ORA$和GS$作为警报名称的开头。
message
警报信号关联的消息,最长为1800字节,若消息长度超出此范围,将报错。
- DBE_ALERT.WAITANY
用于等待当前会话注册列表中的任一警报收到警报信号。该函数不受事务回滚影响。
DBE_ALERT.WAITANY原型为:1 2 3 4 5 6
DBE_ALERT.WAITANY( name OUT VARCHAR2, message OUT VARCHAR2, status OUT INTEGER, timeout IN NUMBER DEFAULT 86400000 )RETURNS VOID;
表6 DBE_ALERT.WAITANY接口参数说明 参数
描述
name
返回发生警报的名称。
message
返回与发生警报关联的消息。
status
返回状态。
- 0表示发生警报。
- 1表示超时。
timeout
等待警报的最长持续时间。如果在指定超时时间内(timeout秒)未检测到警报信号,status将返回1。
- DBE_ALERT.WAITONE
用于等待传入警报收到警报信号,警报必须在当前会话注册列表中。该函数不受事务回滚影响。
DBE_ALERT.WAITONE原型为:1 2 3 4 5 6
DBE_ALERT.WAITONE( name IN VARCHAR2, message OUT VARCHAR2, status OUT INTEGER, timeout IN NUMBER DEFAULT 86400000 )RETURNS VOID;
表7 DBE_ALERT.WAITONE接口参数说明 参数
描述
name
警报名称(不区分大小写)。禁止使用以ORA$和GS$作为警报名称的开头。
message
返回与发生警报关联的消息。
status
返回状态。
- 0表示发生警报。
- 1表超时。
timeout
等待警报的最长持续时间。如果在指定超时时间内(timeout秒)未检测到警报信号,status将返回1。
示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | -- 创建表并插入数据 -- Step1: -- 在接收告警信息的消费端进行注册 --Session1-- gaussdb=# BEGIN gaussdb$# dbe_alert.register('alert_name_test'); gaussdb$# END; gaussdb$# / ANONYMOUS BLOCK EXECUTE -- Step2: -- 在发送告警信息的生产端进行发送 --Session2-- gaussdb=# BEGIN gaussdb$# dbe_alert.signal('alert_name_test', 'message_test'); gaussdb$# commit; gaussdb$# END; gaussdb$# / ANONYMOUS BLOCK EXECUTE -- Step3: -- 在接收告警信息的消费端接受指定alert_name_test的消息,可以获取到对应的message_test告警信息 -- Session1 -- gaussdb=# DECLARE gaussdb-# name varchar2(50) := 'alert_name_test'; gaussdb-# message VARCHAR2(100); gaussdb-# status int; gaussdb-# timeout number := 5; gaussdb-# BEGIN gaussdb$# dbe_alert.set_defaults(5); gaussdb$# dbe_alert.waitone(name, message, status, timeout); gaussdb$# dbe_output.put_line('alert name:' || name); gaussdb$# dbe_output.put_line('message:' || message); gaussdb$# dbe_output.put_line('status:' || status); gaussdb$# END; gaussdb$# / alert name:alert_name_test message:message_test status:0 ANONYMOUS BLOCK EXECUTE -- step1,step2相同,step3使用waitany接口,消费端接收任意一个告警的消息 -- Session1 -- gaussdb=# DECLARE gaussdb-# name varchar2(50); gaussdb-# message VARCHAR2(100); gaussdb-# status int; gaussdb-# timeout number := 5; gaussdb-# BEGIN gaussdb$# dbe_alert.set_defaults(5); gaussdb$# dbe_alert.waitany(name, message, status, timeout); gaussdb$# dbe_output.put_line('alert name:' || name); gaussdb$# dbe_output.put_line('message:' || message); gaussdb$# dbe_output.put_line('status:' || status); gaussdb$# END; gaussdb$# / alert name:ALERT_NAME_TEST message:message_test status:0 ANONYMOUS BLOCK EXECUTE gaussdb=# -- step1,step2相同,step3使用waitany接口,消费端接收任意一个告警的消息--Session1-- gaussdb=# gaussdb=# gaussdb=# -- Step4: gaussdb=# -- 在接收告警信息的消费端删除告警,并通过视图查询 gaussdb=# BEGIN gaussdb$# dbe_alert.remove('alert_name_test'); gaussdb$# dbe_alert.removeall; gaussdb$# END; gaussdb$# / ANONYMOUS BLOCK EXECUTE gaussdb=# SELECT * FROM dbe_alert.dbe_alert_info; name | sid | changed | message ------+-----+---------+--------- (0 rows) |