Skip to content

Commit

Permalink
SQL: Adjust JDBC docs to use milliseconds for timeouts (elastic#79628)
Browse files Browse the repository at this point in the history
Resolves elastic#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.
  • Loading branch information
Lukas Wegmann authored and Adam Locke committed Oct 28, 2021
1 parent c3b80c5 commit edf2306
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/reference/sql/endpoints/jdbc.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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

Expand Down Expand Up @@ -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.


Expand Down

0 comments on commit edf2306

Please sign in to comment.