消息队列函数
在使用消息队列时,发布者通过调用“发送”的系统函数,生成数据并存放至内部队列;订阅者通过调用“查询”的系统函数,从内部队列中获取对应数据。
- 消息队列仅支持在主节点使用。
- 在数据库实例异常时,消息队列会丢失全部数据。
- 消息发布后需要发送者提交事务或主动调用COMMIT来提交消息。在事务回滚时,系统会自动调用内部ROLLBACK函数清除未主动COMMIT的信息。(请求订阅同理)
- 在相同会话下,同一个group, topic只能有一个订阅。
- 消息队列的系统函数操作内部模块时需具有SYSADMIN权限。当前内部模块包括:dbe_alert。
| 参数 | 类型 | 描述 | 取值范围 |
|---|---|---|---|
| message | text | 消息队列中的基本传输单元,指发送者向接收者传递的通信数据,该数据以字符串形式存储。 | 作为系统函数入参时,最大长度为4096字节。 |
| group | text | 为每个特性所使用的消息队列分配独立的模块名,用于区分不同的特性队列以防止干扰。例如:对于客户特性A使用"groupA"组,特性B使用“groupB”组,确保两个组的“topic”严格隔离。 | 作为系统函数入参时,最大长度为127字节。 |
| topic | text | 订阅的主题。每条消息都有与之关联的主题,主题所发挥的作用类似于发送者和接收者之间的中间渠道,负责维护对该主题相关消息感兴趣的接收者名单。 | 作为系统函数入参时,最大长度为127字节。 |
| request_id | uint8 | 订阅、消息的id。 | - |
- mq_register_pull(group text, request_id uint8, topic text)
描述:订阅对应的topic。全局最多支持32个group,每个group最多支持32个topic。当消息队列内存在的group或topic数量达到上限时,订阅操作失败并返回false。在同一个会话中,不能重复订阅group与topic均相同的请求。
参数:参数介绍请参见表1。
返回值类型:boolean
- mq_unregister(group text, request_id uint8, topic text)
参数:参数介绍请参见表1。
返回值类型:boolean
- mq_send_message(group text, topic text, request_id uint8, message text)
参数:参数介绍请参见表1。
返回值类型:boolean
消息队列最大长度为499。在队列已满时不允许生产者继续生产消息,需要消费者将现存消息消费后才可继续生产。
- mq_query(group text, topic text)
描述:获取指定topic下的一条消息。如果当前会话未注册该group和topic,或注册后没有生产者发送消息,或已接收到全部生产者发送的消息时,则返回空值。
参数:参数介绍请参见表1。
返回值类型:text
该函数不受事务回滚与否的影响,一旦成功获取消息,即视为已消费该消息。
- mq_transaction_processing(id uint8, is_message boolean, is_commit boolean)
参数:
- 第一个参数为订阅、消息的id。
- 第二个参数用于指定处理类型,true表示处理消息,false表示处理订阅。
- 第三个参数用于指定事务操作,true表示提交,false表示回滚。
返回值类型:boolean
- mq_get_queue()
描述:获取所有队列信息。执行该函数需要具有SYSADMIN权限。
返回值类型:text
- mq_clear()
描述:清除所有队列信息。执行该函数需要具有SYSADMIN权限。
返回值类型:boolean
- mq_sync_ccn()
返回值类型:boolean
该函数当前版本不可用。
- mq_sync(message_queue text)
参数:序列化的消息队列。
返回值类型:boolean
该函数当前版本不可用。
示例
-- 示例1
-- Session 1
gaussdb=# SELECT mq_register_pull('group', txid_current(), 'topic');
mq_register_pull
------------------
t
(1 row)
-- Session 2
gaussdb=# SELECT mq_send_message('group', 'topic', txid_current(), 'message');
mq_send_message
-----------------
t
(1 row)
-- Session 1
gaussdb=# SELECT mq_query('group', 'topic');
mq_query
----------
message
(1 row)
gaussdb=# SELECT mq_unregister('group', txid_current(), 'topic');
mq_unregister
---------------
t
(1 row)
gaussdb=# SELECT mq_get_queue();
mq_get_queue
--------------------------------------------
{ +
"message_queue": { +
}, +
"prepare_queue": { +
}, +
"prepare_request_queue": { +
}, +
"used_transaction_id_list": []+
}
(1 row)
-- 示例2
gaussdb=# SELECT mq_register_pull('group', 1, 'topic');
mq_register_pull
------------------
t
(1 row)
gaussdb=# SELECT mq_transaction_processing(1, false, true);
mq_transaction_processing
---------------------------
t
(1 row)
gaussdb=# SELECT mq_clear();
mq_clear
----------
t
(1 row)