From edf2306d17550093aa58e34d2420b98953d97777 Mon Sep 17 00:00:00 2001 From: Lukas Wegmann Date: Tue, 26 Oct 2021 13:44:15 +0200 Subject: [PATCH] SQL: Adjust JDBC docs to use milliseconds for timeouts (#79628) Resolves #79480 My initial thought was to change the properties to be interpreted as seconds but this might not be worth it. All relevant places in the code seem to assume the timeouts to be in ms and there does not seem to be a consistent use of ms or s across JDBC drivers (Postgres uses seconds, MySQL uses ms, MS SQL mixes the two depending on the connection property). Hence, just fixing the docs might be easier. --- docs/reference/sql/endpoints/jdbc.asciidoc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/reference/sql/endpoints/jdbc.asciidoc b/docs/reference/sql/endpoints/jdbc.asciidoc index 9e09af2368dcf..04ab36f8839ef 100644 --- a/docs/reference/sql/endpoints/jdbc.asciidoc +++ b/docs/reference/sql/endpoints/jdbc.asciidoc @@ -88,20 +88,20 @@ Timezone used by the driver _per connection_ indicated by its `ID`. [discrete] ===== Network -`connect.timeout` (default 30s):: -Connection timeout (in seconds). That is the maximum amount of time waiting to make a connection to the server. +`connect.timeout` (default `30000`):: +Connection timeout (in milliseconds). That is the maximum amount of time waiting to make a connection to the server. -`network.timeout` (default 60s):: -Network timeout (in seconds). That is the maximum amount of time waiting for the network. +`network.timeout` (default `60000`):: +Network timeout (in milliseconds). That is the maximum amount of time waiting for the network. -`page.timeout` (default 45s):: -Page timeout (in seconds). That is the maximum amount of time waiting for a page. +`page.timeout` (default `45000`):: +Page timeout (in milliseconds). That is the maximum amount of time waiting for a page. -`page.size` (default 1000):: +`page.size` (default `1000`):: Page size (in entries). The number of results returned per page by the server. -`query.timeout` (default 90s):: -Query timeout (in seconds). That is the maximum amount of time waiting for a query to return. +`query.timeout` (default `90000`):: +Query timeout (in milliseconds). That is the maximum amount of time waiting for a query to return. [[jdbc-cfg-auth]] [discrete] @@ -115,7 +115,7 @@ Query timeout (in seconds). That is the maximum amount of time waiting for a que [discrete] ==== SSL -`ssl` (default false):: Enable SSL +`ssl` (default `false`):: Enable SSL `ssl.keystore.location`:: key store (if used) location @@ -150,7 +150,7 @@ will be - typically the first in natural ascending order) for fields with multip [discrete] ==== Additional -`validate.properties` (default true):: If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception +`validate.properties` (default `true`):: If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception will be thrown if the provided property cannot be recognized.