From 46827b270ca83e83753cdb3c71d08334668c10a1 Mon Sep 17 00:00:00 2001
From: felipe stival <14948182+v0idpwn@users.noreply.github.com>
Date: Fri, 27 Dec 2024 14:23:51 -0300
Subject: [PATCH] Add note about conditional read being experimental (#370)
---
docs/api/sql/functions.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/api/sql/functions.md b/docs/api/sql/functions.md
index 8819d174..ad680cad 100644
--- a/docs/api/sql/functions.md
+++ b/docs/api/sql/functions.md
@@ -133,7 +133,7 @@ RETURNS SETOF pgmq.message_record
| queue_name | text | The name of the queue |
| vt | integer | Time in seconds that the message become invisible after reading |
| qty | integer | The number of messages to read from the queue. Defaults to 1 |
-| conditional | jsonb | Filters the messages by their json content. Defaults to '{}' - no filtering |
+| conditional | jsonb | Filters the messages by their json content. Defaults to '{}' - no filtering. **This feature is experimental, and the API is subject to change in future releases** |
Examples:
@@ -189,7 +189,7 @@ RETURNS SETOF pgmq.message_record
| qty | integer | The number of messages to read from the queue. Defaults to 1. |
| max_poll_seconds | integer | Time in seconds to wait for new messages to reach the queue. Defaults to 5. |
| poll_interval_ms | integer | Milliseconds between the internal poll operations. Defaults to 100. |
-| conditional | jsonb | Filters the messages by their json content. Defaults to '{}' - no filtering |
+| conditional | jsonb | Filters the messages by their json content. Defaults to '{}' - no filtering. **This feature is experimental, and the API is subject to change in future releases** |
Example: