Skip to content

Commit edf2306

Browse files
Lukas WegmannAdam Locke
Lukas Wegmann
authored and
Adam Locke
committed
SQL: Adjust JDBC docs to use milliseconds for timeouts (elastic#79628)
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.
1 parent c3b80c5 commit edf2306

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/reference/sql/endpoints/jdbc.asciidoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,20 @@ Timezone used by the driver _per connection_ indicated by its `ID`.
8888
[discrete]
8989
===== Network
9090

91-
`connect.timeout` (default 30s)::
92-
Connection timeout (in seconds). That is the maximum amount of time waiting to make a connection to the server.
91+
`connect.timeout` (default `30000`)::
92+
Connection timeout (in milliseconds). That is the maximum amount of time waiting to make a connection to the server.
9393

94-
`network.timeout` (default 60s)::
95-
Network timeout (in seconds). That is the maximum amount of time waiting for the network.
94+
`network.timeout` (default `60000`)::
95+
Network timeout (in milliseconds). That is the maximum amount of time waiting for the network.
9696

97-
`page.timeout` (default 45s)::
98-
Page timeout (in seconds). That is the maximum amount of time waiting for a page.
97+
`page.timeout` (default `45000`)::
98+
Page timeout (in milliseconds). That is the maximum amount of time waiting for a page.
9999

100-
`page.size` (default 1000)::
100+
`page.size` (default `1000`)::
101101
Page size (in entries). The number of results returned per page by the server.
102102

103-
`query.timeout` (default 90s)::
104-
Query timeout (in seconds). That is the maximum amount of time waiting for a query to return.
103+
`query.timeout` (default `90000`)::
104+
Query timeout (in milliseconds). That is the maximum amount of time waiting for a query to return.
105105

106106
[[jdbc-cfg-auth]]
107107
[discrete]
@@ -115,7 +115,7 @@ Query timeout (in seconds). That is the maximum amount of time waiting for a que
115115
[discrete]
116116
==== SSL
117117

118-
`ssl` (default false):: Enable SSL
118+
`ssl` (default `false`):: Enable SSL
119119

120120
`ssl.keystore.location`:: key store (if used) location
121121

@@ -150,7 +150,7 @@ will be - typically the first in natural ascending order) for fields with multip
150150
[discrete]
151151
==== Additional
152152

153-
`validate.properties` (default true):: If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception
153+
`validate.properties` (default `true`):: If disabled, it will ignore any misspellings or unrecognizable properties. When enabled, an exception
154154
will be thrown if the provided property cannot be recognized.
155155

156156

0 commit comments

Comments
 (0)