From: Juliana Fajardini <jufajardini@oisf.net>
Date: Fri, 4 Apr 2025 22:17:55 +0000 (-0700)
Subject: doc/pgsql: document CopyOut-related response msgs
X-Git-Tag: suricata-8.0.0-beta1~66
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f06ec5336e7f395c149845577ac714c6f0c4ca8c;p=thirdparty%2Fsuricata.git

doc/pgsql: document CopyOut-related response msgs

Related to
Task #4854
---

diff --git a/doc/userguide/output/eve/eve-json-format.rst b/doc/userguide/output/eve/eve-json-format.rst
index 744591b8a9..171f38eb2f 100644
--- a/doc/userguide/output/eve/eve-json-format.rst
+++ b/doc/userguide/output/eve/eve-json-format.rst
@@ -2548,6 +2548,12 @@ pgsql flow. Some of the possible request messages are:
 * "data_size": in bytes. When one or many ``DataRow`` messages are parsed, the
   total size in bytes of the data returned
 * "command_completed": string. Informs the command just completed by the backend
+* "copy_out_response": object. Indicates the beginning of a CopyTo mode, shows
+  how many columns will be copied to STDOUT (``copy_column_cnt`` field)
+* "copy_data_out": object. Consolidated data on the CopyData sent by the backend
+  in a CopyOut transaction
+* "copy_done": string. Similar to ``command_completed`` but sent after the
+  backend finishes sending a batch of ``CopyData`` messages
 * "ssl_accepted": bool. With this event, the initial PGSQL SSL Handshake
   negotiation is complete in terms of tracking and logging. The session will be
   upgraded to use TLS encryption