add docs for jdbc extra credentials, fixing #1910

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

@@ -38,6 +38,8 @@ appropriate for your setup:
     connection-user=exampleuser
     connection-password=examplepassword
 
+.. include:: jdbc-extra-credentials.fragment
+
 .. note::
 
     Trino uses the new ClickHouse driver(``com.clickhouse.jdbc.ClickHouseDriver``)

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

@@ -43,6 +43,8 @@ secured by basic authentication by updating the URL and adding credentials:
     connection-user=root
     connection-password=secret
 
+.. include:: jdbc-extra-credentials.fragment
+
 Now you can access your Druid database in Trino with the ``druiddb`` catalog
 name from the properties file.
 

docs/src/main/sphinx/connector/jdbc-extra-credentials.fragment

@@ -0,0 +1,9 @@
+In some cases, users may want to hide the credentials from the configuration file for security considerations. They can use ``user-credential-name`` and ``password-credential-name`` to specify the credential keys instead of the actual credentials. Then when querying, the connector can get the actual credentials from the connection string or command-line arguments with the keys:
+
+
+.. code-block:: none
+
+    user-credential-name=extra-credential-name
+    password-credential-name=extra-credential-password
+
+Users can pass the extra credentials via ``--extra-credential`` with :doc:`/installation/cli` and ``extraCredentials`` with :doc:`/installation/jdbc`.

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

@@ -42,10 +42,12 @@ available in the `SingleStore JDBC driver documentation
 <https://docs.singlestore.com/db/v7.6/en/developer-resources/connect-with-application-development-tools/connect-with-java-jdbc/the-singlestore-jdbc-driver.html#connection-string-parameters>`_.
 
 The ``connection-user`` and ``connection-password`` are typically required and
-determine the user credentials for the connection, often a service user. You can
-use :doc:`secrets </security/secrets>` to avoid actual values in the catalog
-properties files.
+determine the user credentials for the connection, often a service user. 
 
+.. include:: jdbc-extra-credentials.fragment
+
+You can also use other solutions mentioned in :doc:`secrets </security/secrets>` 
+to avoid actual values in the catalog properties files.
 
 .. _singlestore-tls:
 

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

@@ -50,9 +50,12 @@ the server, and serves as a `workaround for a known issue
     connection-url=jdbc:mysql://example.net:3306?serverTimezone=UTC
 
 The ``connection-user`` and ``connection-password`` are typically required and
-determine the user credentials for the connection, often a service user. You can
-use :doc:`secrets </security/secrets>` to avoid actual values in the catalog
-properties files.
+determine the user credentials for the connection, often a service user. 
+
+.. include:: jdbc-extra-credentials.fragment
+
+You can also use other solutions mentioned in :doc:`secrets </security/secrets>` 
+to avoid actual values in the catalog properties files.
 
 .. _mysql-tls:
 

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

@@ -46,9 +46,11 @@ Database JDBC driver documentation
 for more information.
 
 The ``connection-user`` and ``connection-password`` are typically required and
-determine the user credentials for the connection, often a service user. You can
-use :doc:`secrets </security/secrets>` to avoid actual values in the catalog
-properties files.
+determine the user credentials for the connection, often a service user. 
+
+.. include:: jdbc-extra-credentials.fragment
+
+You can also use other solutions mentioned in :doc:`secrets </security/secrets>` to avoid actual values in the catalog properties files.
 
 .. note::
     Oracle does not expose metadata comment via ``REMARKS`` column by default

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

@@ -75,6 +75,8 @@ Property Name                                      Required   Description
 
 .. include:: non-transactional-insert.fragment
 
+.. include:: jdbc-extra-credentials.fragment
+
 Querying Phoenix tables
 -------------------------
 

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

@@ -46,9 +46,12 @@ can have adverse effects on the connector behavior or not work with the
 connector.
 
 The ``connection-user`` and ``connection-password`` are typically required and
-determine the user credentials for the connection, often a service user. You can
-use :doc:`secrets </security/secrets>` to avoid actual values in the catalog
-properties files.
+determine the user credentials for the connection, often a service user. 
+
+.. include:: jdbc-extra-credentials.fragment
+
+You can also use other solutions mentioned in :doc:`secrets </security/secrets>` 
+to avoid actual values in the catalog properties files.
 
 .. _postgresql-tls:
 

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

@@ -78,6 +78,8 @@ catalog named ``sales`` using the configured connector.
 
 .. include:: non-transactional-insert.fragment
 
+.. include:: jdbc-extra-credentials.fragment
+
 Querying Redshift
 -----------------
 

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

@@ -90,6 +90,8 @@ catalog named ``sales`` using the configured connector.
 
 .. include:: non-transactional-insert.fragment
 
+.. include:: jdbc-extra-credentials.fragment
+
 Querying SQL Server
 -------------------
 

docs/src/main/sphinx/installation/cli.rst

@@ -173,6 +173,8 @@ mode:
     - Sets the username for :ref:`cli-username-password-auth`. Defaults to your
       operating system username. You can override the default username,
       if your cluster uses a different username or authentication mechanism.
+  * - ``--extra-credential``
+    - Sets the extra credential keys, multiple extra credential keys can be used with format ``--extra-credential 'extra-credential-name=admin' --extra-credential 'extra-credential-password=password'``.
 
 .. _cli-tls: