]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
pgsql: document CopyOut messages
authorJuliana Fajardini <jufajardini@oisf.net>
Thu, 1 May 2025 17:20:41 +0000 (14:20 -0300)
committerJuliana Fajardini <jufajardini@oisf.net>
Wed, 4 Jun 2025 18:21:32 +0000 (15:21 -0300)
Related to
Task #7644

etc/schema.json

index 2205fbc92aadde68ca7bba5d2ec5975e27b43534..582171dd87ac81f7a9252d47eb1986a2dcd0d19e 100644 (file)
                         },
                         "copy_data_out": {
                             "type": "object",
+                            "description": "CopyData message from CopyOut mode",
                             "properties": {
-                                "data_size": {
-                                    "type": "integer"
-                                },
                                 "row_count": {
-                                    "type": "integer"
+                                    "type": "integer",
+                                    "description": "Number of rows sent in CopyData messages"
+                                },
+                                "data_size": {
+                                    "type": "integer",
+                                    "description": "Accumulated data size of all CopyData messages sent"
                                 }
                             }
                         },
                         "copy_out_response": {
                             "type": "object",
+                            "description": "Backend/server response accepting CopyOut mode",
                             "properties": {
                                 "copy_column_count": {
-                                    "type": "integer"
+                                    "type": "integer",
+                                    "description": "Number of columns that will be copied in the CopyData message"
                                 }
                             }
                         },