From 9e0a33ad0390f429f61f49c526465fd52df4afcf Mon Sep 17 00:00:00 2001
From: Nathan Xu <nathan.xu@mongodb.com>
Date: Fri, 8 Nov 2024 21:38:44 -0500
Subject: [PATCH] update MongoConnectionProvider as per code review comments

---
 .../jdbc/MongoConnectionProvider.java         | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java b/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
index 90b9c5d..604a476 100644
--- a/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
+++ b/src/main/java/com/mongodb/hibernate/jdbc/MongoConnectionProvider.java
@@ -51,6 +51,25 @@
  * href="https://www.mongodb.com/docs/manual/reference/connection-string/">connection string</a>, in which database name
  * must be provided to align with JDBC URL's convention. The other two JDBC properties are optional.
  *
+ * <table>
+ *     <tr><th>Property</th><th>Description</th><th>Required</th></tr>
+ *     <tr>
+ *         <td>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_URL jakarta.persistence.jdbc.url}</td>
+ *         <td>MongoDB <a href="https://www.mongodb.com/docs/manual/reference/connection-string/">connection string</a></td>
+ *         <td>✓</td>
+ *     </tr>
+ *     <tr>
+ *         <td>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_USER jakarta.persistence.jdbc.user}</td>
+ *         <td>{@code userName} for <a href="https://mongodb.github.io/mongo-java-driver/5.2/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createCredential">MongoCredential.createCredential</a></td>
+ *         <td></td>
+ *     </tr>
+ *     <tr>
+ *         <td>{@linkplain org.hibernate.cfg.JdbcSettings#JAKARTA_JDBC_PASSWORD jakarta.persistence.jdbc.password}</td>
+ *         <td>{@code password} for <a href="https://mongodb.github.io/mongo-java-driver/5.2/apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createCredential">MongoCredential.createCredential</a></td>
+ *         <td></td>
+ *     </tr>
+ * </table>
+ *
  * @see ConnectionProvider
  * @see JdbcSettings#JAKARTA_JDBC_URL
  * @see JdbcSettings#JAKARTA_JDBC_USER