diff --git a/docs/en_US/images/query_output_notifications_listen.png b/docs/en_US/images/query_output_notifications_listen.png new file mode 100644 index 000000000..c86f6ca65 Binary files /dev/null and b/docs/en_US/images/query_output_notifications_listen.png differ diff --git a/docs/en_US/images/query_output_notifications_notify.png b/docs/en_US/images/query_output_notifications_notify.png new file mode 100644 index 000000000..8ed9e23d5 Binary files /dev/null and b/docs/en_US/images/query_output_notifications_notify.png differ diff --git a/docs/en_US/images/query_output_notifications_panel.png b/docs/en_US/images/query_output_notifications_panel.png new file mode 100644 index 000000000..7f637fe4d Binary files /dev/null and b/docs/en_US/images/query_output_notifications_panel.png differ diff --git a/docs/en_US/query_tool.rst b/docs/en_US/query_tool.rst index d594da70b..3e33a57de 100644 --- a/docs/en_US/query_tool.rst +++ b/docs/en_US/query_tool.rst @@ -258,6 +258,36 @@ query took to complete and how many rows were retrieved: :alt: Query tool output information :align: center +Notifications Panel +******************* + +Use the *Notifications* tab to view the notifications using PostgreSQL *Listen/ +Notify* feature. For more details see `PostgreSQL documentation `_. + +Example: + +1. Execute *LISTEN "foo"* in first *Query Tool* session + +.. image:: images/query_output_notifications_listen.png + :alt: Query tool notifications listen + :align: center + +2. In the another *Query Tool* session, execute *Notify* command or *pg_notify* +function to send the notification of the event together with the payload. + +.. image:: images/query_output_notifications_notify.png + :alt: Query tool notifications notify + :align: center + +3. You can observe the *Notification* tab in the first *Query Tool* session +where it shows the Recorded time, Event, Process ID, and the Payload of the +particular channel. + +.. image:: images/query_output_notifications_panel.png + :alt: Query tool notifications panel + :align: center + Query History Panel ******************* diff --git a/docs/en_US/release_notes_5_2.rst b/docs/en_US/release_notes_5_2.rst index 9502834dd..c1411276b 100644 --- a/docs/en_US/release_notes_5_2.rst +++ b/docs/en_US/release_notes_5_2.rst @@ -18,6 +18,7 @@ Housekeeping Bug fixes ********* +| `Issue #4001 `_ - Updated docs and screenshots to cover the Notifications tab on the Query Tool. | `Issue #5519 `_ - Ensure that the query tool tab should be closed after server disconnection when auto-commit/auto-rollback is set to false. | `Issue #5908 `_ - Fixed an issue where shortcut keys are not working with manage macro. | `Issue #6076 `_ - Fixed an issue where correct error not thrown while importing servers and JSON file has incorrect/insufficient keys.