Added documentation for SSL support

see vert-x3#43

Author: Mart-Bogdan

src/main/asciidoc/groovy/index.adoc

@@ -228,7 +228,9 @@ Both the PostgreSql and MySql clients take the same configuration:
   "password" : <your-password>,
   "database" : <name-of-your-database>,
   "charset" : <name-of-the-character-set>,
-  "queryTimeout" : <timeout-in-milliseconds>
+  "queryTimeout" : <timeout-in-milliseconds>,
+  "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+  "sslrootcert" : <path to file with certificate>
 }
 ----
 
@@ -239,4 +241,11 @@ Both the PostgreSql and MySql clients take the same configuration:
 `password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
 `database`:: The name of the database you want to connect to. Defaults to `testdb`.
 `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
-`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`sslmode` ::
+   "disable" ::: only try a non-SSL connection
+   "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+   "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+   "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+   "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+`sslrootcert` :: Path to SSL root certificate file

src/main/asciidoc/java/index.adoc

@@ -196,7 +196,9 @@ Both the PostgreSql and MySql clients take the same configuration:
   "password" : <your-password>,
   "database" : <name-of-your-database>,
   "charset" : <name-of-the-character-set>,
-  "queryTimeout" : <timeout-in-milliseconds>
+  "queryTimeout" : <timeout-in-milliseconds>,
+  "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+  "sslrootcert" : <path to file with certificate>
 }
 ----
 
@@ -207,4 +209,11 @@ Both the PostgreSql and MySql clients take the same configuration:
 `password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
 `database`:: The name of the database you want to connect to. Defaults to `testdb`.
 `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
-`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`sslmode` ::
+   "disable" ::: only try a non-SSL connection
+   "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+   "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+   "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+   "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+`sslrootcert` :: Path to SSL root certificate file

src/main/asciidoc/js/index.adoc

@@ -234,7 +234,9 @@ Both the PostgreSql and MySql clients take the same configuration:
   "password" : <your-password>,
   "database" : <name-of-your-database>,
   "charset" : <name-of-the-character-set>,
-  "queryTimeout" : <timeout-in-milliseconds>
+  "queryTimeout" : <timeout-in-milliseconds>,
+  "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+  "sslrootcert" : <path to file with certificate>
 }
 ----
 
@@ -245,4 +247,11 @@ Both the PostgreSql and MySql clients take the same configuration:
 `password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
 `database`:: The name of the database you want to connect to. Defaults to `testdb`.
 `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
-`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`sslmode` ::
+   "disable" ::: only try a non-SSL connection
+   "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+   "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+   "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+   "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+`sslrootcert` :: Path to SSL root certificate file

src/main/asciidoc/kotlin/index.adoc

@@ -228,7 +228,9 @@ Both the PostgreSql and MySql clients take the same configuration:
   "password" : <your-password>,
   "database" : <name-of-your-database>,
   "charset" : <name-of-the-character-set>,
-  "queryTimeout" : <timeout-in-milliseconds>
+  "queryTimeout" : <timeout-in-milliseconds>,
+  "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+  "sslrootcert" : <path to file with certificate>
 }
 ----
 
@@ -239,4 +241,11 @@ Both the PostgreSql and MySql clients take the same configuration:
 `password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
 `database`:: The name of the database you want to connect to. Defaults to `testdb`.
 `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
-`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`sslmode` ::
+   "disable" ::: only try a non-SSL connection
+   "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+   "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+   "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+   "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+`sslrootcert` :: Path to SSL root certificate file

src/main/asciidoc/ruby/index.adoc

@@ -234,7 +234,9 @@ Both the PostgreSql and MySql clients take the same configuration:
   "password" : <your-password>,
   "database" : <name-of-your-database>,
   "charset" : <name-of-the-character-set>,
-  "queryTimeout" : <timeout-in-milliseconds>
+  "queryTimeout" : <timeout-in-milliseconds>,
+  "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+  "sslrootcert" : <path to file with certificate>
 }
 ----
 
@@ -245,4 +247,11 @@ Both the PostgreSql and MySql clients take the same configuration:
 `password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
 `database`:: The name of the database you want to connect to. Defaults to `testdb`.
 `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
-`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+`sslmode` ::
+   "disable" ::: only try a non-SSL connection
+   "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+   "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+   "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+   "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+`sslrootcert` :: Path to SSL root certificate file

src/main/java/io/vertx/ext/asyncsql/package-info.java

@@ -185,7 +185,9 @@
  *   "password" : <your-password>,
  *   "database" : <name-of-your-database>,
  *   "charset" : <name-of-the-character-set>,
- *   "queryTimeout" : <timeout-in-milliseconds>
+ *   "queryTimeout" : <timeout-in-milliseconds>,
+ *   "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
+ *   "sslrootcert" : <path to file with certificate>
  * }
  * ----
  *
@@ -197,6 +199,13 @@
  * `database`:: The name of the database you want to connect to. Defaults to `testdb`.
  * `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
  * `queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
+ * `sslmode` ::
+ *    "disable" ::: only try a non-SSL connection
+ *    "prefer"  ::: first try an SSL connection; if that fails, try a non-SSL connection
+ *    "require"  ::: only try an SSL connection, but don't verify Certificate Authority
+ *    "verify-ca"  ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
+ *    "verify-full"  ::: only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the server host name matches that in the certificate
+ * `sslrootcert` :: Path to SSL root certificate file
  */
 @Document(fileName = "index.adoc")
 @ModuleGen(name = "vertx-mysql-postgresql", groupPackage = "io.vertx") package io.vertx.ext.asyncsql;