PostgreSQL通知监听器

本项目是一个Python库，用于监听PostgreSQL数据库的通知。它提供了一种简单的方法，在数据库中发生特定事件时执行函数。

工作原理

监听器连接到PostgreSQL数据库并设置一个通知通道。然后，您可以将回调函数附加到该通道，当接收到通知时将执行这些函数。

安装

要安装库，请运行：pip install postgresql-notification-listener

使用方法

要使用此库，请按照以下步骤操作

• 在Python脚本中导入库：from postgresql_notification_listener import NotificationListener
• 创建监听器实例 listener = NotificationListener("host=your_host port=your_port dbname=your_database user=your_username password=your_password")
• 定义一个当接收到通知时将被执行的回调函数。
• 使用subscribe_to_channel方法将您的回调函数附加到通知通道：listener.subscribe_to_channel("channel_to_listen", callback_function)
• 通过调用start方法开始监听通知：listener.start()
• 您可以通过NOTIFY channel_to_listen语句从PostgreSQL触发通知。
• 《start》方法会在被调用时一次性调用所有附加的回调函数。如果您不希望这种行为，请在start方法中传递initial_run=False参数：listener.start(initial_run=False)
• 您可以从监听实例的last_notification属性中获取导致回调的通知：listener.last_notification

API

• NotificationListener：此库的主要类。它负责设置通知通道和管理回调。
  • subscribe_to_channel：将回调函数附加到特定通道。subscribe_to_channel方法需要两个必需参数：要监听的通道名称以及在接收到通知时执行的回调函数。
  • start：开始监听通知。如果您不希望在调用时一次性调用所有附加的回调，请将initial_run=False作为参数传递。
  • last_notification：返回导致回调的最新通知。