VladPolskiy/mariadb-connector-nodejs
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-connector-nodejs.git synced 2025-08-15 21:22:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update new default value of connectTimeout since v2.5.6

Browse Source
This commit is contained in:
Nuno Balbona
2022-12-12 20:46:09 +01:00
committed by diego dupin
parent 914fab458e
commit ebef14590c
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/callback-api.md
View File

@ -256,7 +256,7 @@ Essential options list:
| **`database`** | Default database to use when establishing the connection. | *string* |
| **`socketPath`** | Permits connections to the database through the Unix domain socket or named pipe. | *string* |
| **`compress`** | Compresses the exchange with the database through gzip. This permits better performance when the database is not in the same location. |*boolean*| false|
| **`connectTimeout`** | Sets the connection timeout in milliseconds. |*integer* | 10 000|
| **`connectTimeout`** | Sets the connection timeout in milliseconds. |*integer* | 1 000|
| **`socketTimeout`** | Sets the socket timeout in milliseconds after connection succeeds. A value of `0` disables the timeout. |*integer* | 0|
| **`queryTimeout`** | Set maximum query time in ms (an error will be thrown if limit is reached). 0 or undefined meaning no timeout. This can be superseded for a query using `timeout` option|*int* |0|
| **`rowsAsArray`** | Returns result-sets as arrays, rather than JSON. This is a faster way to get results. For more information, see Query. |*boolean* | false|

2
documentation/promise-api.md
View File

@ -349,7 +349,7 @@ Essential options list:
| **`database`** | Default database to use when establishing the connection. | *string* |
| **`socketPath`** | Permits connections to the database through the Unix domain socket or named pipe. | *string* |
| **`compress`** | Compresses the exchange with the database through gzip. This permits better performance when the database is not in the same location. |*boolean*| false|
| **`connectTimeout`** | Sets the connection timeout in milliseconds. |*integer* | 10 000|
| **`connectTimeout`** | Sets the connection timeout in milliseconds. |*integer* | 1 000|
| **`socketTimeout`** | Sets the socket timeout in milliseconds after connection succeeds. A value of `0` disables the timeout. |*integer* | 0|
| **`queryTimeout`** | Set maximum query time in ms (an error will be thrown if limit is reached). 0 or undefined meaning no timeout. This can be superseded for a query using [`timeout`](https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/master/documentation/promise-api.md#timeout) option|*int* |0|
| **`rowsAsArray`** | Returns result-sets as arrays, rather than JSON. This is a faster way to get results. For more information, see Query. |*boolean* | false|