Add support for appending queries in sql based connectors

docs/src/main/sphinx/connector/clickhouse.rst

@@ -84,6 +84,8 @@ configured connector to create a catalog named ``sales``.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``1000``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/druid.rst

@@ -55,6 +55,8 @@ properties files.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/ignite.rst

@@ -65,6 +65,8 @@ configured connector to create a catalog named ``sales``.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``1000``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/mysql.rst

@@ -90,6 +90,8 @@ creates a catalog named ``sales`` using the configured connector.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/oracle.rst

@@ -87,6 +87,8 @@ you name the property file ``sales.properties``, Trino creates a catalog named
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/phoenix.rst

@@ -57,6 +57,8 @@ Property name                                      Required   Description
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``5000``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/postgresql.rst

@@ -88,6 +88,8 @@ catalog named ``sales`` using the configured connector.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/query-comment-format.fragment

@@ -0,0 +1,50 @@
+Appending query metadata
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The optional parameter ``query.comment-format`` allows you to configure a SQL
+comment that is sent to the datasource with each query. The format of this
+comment can contain any characters and the following metadata:
+
+* ``$QUERY_ID``: The identifier of the query.
+* ``$USER``: The name of the user who submits the query to Trino.
+* ``$SOURCE``: The identifier of the client tool used to submit the query, for
+  example ``trino-cli``.
+* ``$TRACE_TOKEN``: The trace token configured with the client tool.
+
+The comment can provide more context about the query. This additional
+information is available in the logs of the datasource. To include environment
+variables from the Trino cluster with the comment , use the
+``${ENV:VARIABLE-NAME}`` syntax.
+
+The following example sets a simple comment that identifies each query sent by
+Trino:
+
+.. code-block:: text
+
+  query.comment-format=Query sent by Trino.
+
+With this configuration, a query such as ``SELECT * FROM example_table;`` is
+sent to the datasource with the comment appended:
+
+.. code-block:: text
+
+    SELECT * FROM example_table; /*Query sent by Trino.*/
+
+The following example improves on the preceding example by using metadata:
+
+.. code-block:: text
+
+    query.comment-format=Query $QUERY_ID sent by user $USER from Trino.
+
+If ``Jane`` sent the query with the query identifier
+``20230622_180528_00000_bkizg``, the following comment string is sent to the
+datasource:
+
+.. code-block:: text
+
+    SELECT * FROM example_table; /*Query 20230622_180528_00000_bkizg sent by user Jane from Trino.*/
+
+.. note::
+
+  Certain JDBC driver settings and logging configurations might cause the
+  comment to be removed.

docs/src/main/sphinx/connector/redshift.rst

@@ -79,6 +79,8 @@ catalog named ``sales`` using the configured connector.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/singlestore.rst

@@ -78,6 +78,8 @@ will create a catalog named ``sales`` using the configured connector.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment
 

docs/src/main/sphinx/connector/sqlserver.rst

@@ -86,6 +86,8 @@ catalog named ``sales`` using the configured connector.
 
 .. include:: jdbc-common-configurations.fragment
 
+.. include:: query-comment-format.fragment
+
 .. |default_domain_compaction_threshold| replace:: ``32``
 .. include:: jdbc-domain-compaction-threshold.fragment