Skip to content

Commit 188d35b

Browse files
Mart-BogdanMcHunkyTrunk
Mart-Bogdan
authored and
McHunkyTrunk
committed
Added documentation for SSL support
see #43
1 parent e023d9a commit 188d35b

File tree

6 files changed

+77
-11
lines changed

6 files changed

+77
-11
lines changed

‎src/main/asciidoc/groovy/index.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,9 @@ Both the PostgreSql and MySql clients take the same configuration:
228228
"password" : <your-password>,
229229
"database" : <name-of-your-database>,
230230
"charset" : <name-of-the-character-set>,
231-
"queryTimeout" : <timeout-in-milliseconds>
231+
"queryTimeout" : <timeout-in-milliseconds>,
232+
"sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
233+
"sslrootcert" : <path to file with certificate>
232234
}
233235
----
234236

@@ -239,4 +241,13 @@ Both the PostgreSql and MySql clients take the same configuration:
239241
`password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
240242
`database`:: The name of the database you want to connect to. Defaults to `testdb`.
241243
`charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
242-
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
244+
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
245+
`sslmode` :: If you want to enable SSL support you should enable this parameter.
246+
For example to connect Heroku you will need to use *prefer*.
247+
248+
"disable" ::: only try a non-SSL connection
249+
"prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
250+
"require" ::: only try an SSL connection, but don't verify Certificate Authority
251+
"verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
252+
"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
253+
`sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.

‎src/main/asciidoc/java/index.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,9 @@ Both the PostgreSql and MySql clients take the same configuration:
196196
"password" : <your-password>,
197197
"database" : <name-of-your-database>,
198198
"charset" : <name-of-the-character-set>,
199-
"queryTimeout" : <timeout-in-milliseconds>
199+
"queryTimeout" : <timeout-in-milliseconds>,
200+
"sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
201+
"sslrootcert" : <path to file with certificate>
200202
}
201203
----
202204

@@ -207,4 +209,13 @@ Both the PostgreSql and MySql clients take the same configuration:
207209
`password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
208210
`database`:: The name of the database you want to connect to. Defaults to `testdb`.
209211
`charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
210-
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
212+
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
213+
`sslmode` :: If you want to enable SSL support you should enable this parameter.
214+
For example to connect Heroku you will need to use *prefer*.
215+
216+
"disable" ::: only try a non-SSL connection
217+
"prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
218+
"require" ::: only try an SSL connection, but don't verify Certificate Authority
219+
"verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
220+
"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
221+
`sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.

‎src/main/asciidoc/js/index.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ Both the PostgreSql and MySql clients take the same configuration:
234234
"password" : <your-password>,
235235
"database" : <name-of-your-database>,
236236
"charset" : <name-of-the-character-set>,
237-
"queryTimeout" : <timeout-in-milliseconds>
237+
"queryTimeout" : <timeout-in-milliseconds>,
238+
"sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
239+
"sslrootcert" : <path to file with certificate>
238240
}
239241
----
240242

@@ -245,4 +247,13 @@ Both the PostgreSql and MySql clients take the same configuration:
245247
`password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
246248
`database`:: The name of the database you want to connect to. Defaults to `testdb`.
247249
`charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
248-
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
250+
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
251+
`sslmode` :: If you want to enable SSL support you should enable this parameter.
252+
For example to connect Heroku you will need to use *prefer*.
253+
254+
"disable" ::: only try a non-SSL connection
255+
"prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
256+
"require" ::: only try an SSL connection, but don't verify Certificate Authority
257+
"verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
258+
"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
259+
`sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.

‎src/main/asciidoc/kotlin/index.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,9 @@ Both the PostgreSql and MySql clients take the same configuration:
228228
"password" : <your-password>,
229229
"database" : <name-of-your-database>,
230230
"charset" : <name-of-the-character-set>,
231-
"queryTimeout" : <timeout-in-milliseconds>
231+
"queryTimeout" : <timeout-in-milliseconds>,
232+
"sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
233+
"sslrootcert" : <path to file with certificate>
232234
}
233235
----
234236

@@ -239,4 +241,13 @@ Both the PostgreSql and MySql clients take the same configuration:
239241
`password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
240242
`database`:: The name of the database you want to connect to. Defaults to `testdb`.
241243
`charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
242-
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
244+
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
245+
`sslmode` :: If you want to enable SSL support you should enable this parameter.
246+
For example to connect Heroku you will need to use *prefer*.
247+
248+
"disable" ::: only try a non-SSL connection
249+
"prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
250+
"require" ::: only try an SSL connection, but don't verify Certificate Authority
251+
"verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
252+
"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
253+
`sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.

‎src/main/asciidoc/ruby/index.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ Both the PostgreSql and MySql clients take the same configuration:
234234
"password" : <your-password>,
235235
"database" : <name-of-your-database>,
236236
"charset" : <name-of-the-character-set>,
237-
"queryTimeout" : <timeout-in-milliseconds>
237+
"queryTimeout" : <timeout-in-milliseconds>,
238+
"sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
239+
"sslrootcert" : <path to file with certificate>
238240
}
239241
----
240242

@@ -245,4 +247,13 @@ Both the PostgreSql and MySql clients take the same configuration:
245247
`password`:: The password to connect to the database. Default is not set, i.e. it uses no password.
246248
`database`:: The name of the database you want to connect to. Defaults to `testdb`.
247249
`charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
248-
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
250+
`queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
251+
`sslmode` :: If you want to enable SSL support you should enable this parameter.
252+
For example to connect Heroku you will need to use *prefer*.
253+
254+
"disable" ::: only try a non-SSL connection
255+
"prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
256+
"require" ::: only try an SSL connection, but don't verify Certificate Authority
257+
"verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
258+
"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
259+
`sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,9 @@
185185
* "password" : <your-password>,
186186
* "database" : <name-of-your-database>,
187187
* "charset" : <name-of-the-character-set>,
188-
* "queryTimeout" : <timeout-in-milliseconds>
188+
* "queryTimeout" : <timeout-in-milliseconds>,
189+
* "sslmode" : <"disable"|"prefer"|"require"|"verify-ca"|"verify-full">,
190+
* "sslrootcert" : <path to file with certificate>
189191
* }
190192
* ----
191193
*
@@ -197,6 +199,15 @@
197199
* `database`:: The name of the database you want to connect to. Defaults to `testdb`.
198200
* `charset`:: The name of the character set you want to use for the connection. Defaults to `UTF-8`.
199201
* `queryTimeout`:: The timeout to wait for a query in milliseconds. Defaults to `10000` (= 10 seconds).
202+
* `sslmode` :: If you want to enable SSL support you should enable this parameter.
203+
* For example to connect Heroku you will need to use *prefer*.
204+
*
205+
* "disable" ::: only try a non-SSL connection
206+
* "prefer" ::: first try an SSL connection; if that fails, try a non-SSL connection
207+
* "require" ::: only try an SSL connection, but don't verify Certificate Authority
208+
* "verify-ca" ::: only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA)
209+
* "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
210+
* `sslrootcert` :: Path to SSL root certificate file. Is used if you want to verify privately issued certificate.
200211
*/
201212
@Document(fileName = "index.adoc")
202213
@ModuleGen(name = "vertx-mysql-postgresql", groupPackage = "io.vertx") package io.vertx.ext.asyncsql;

0 commit comments

Comments
 (0)