Skip to content

fix: bound connection acquisition with queryTimeout to prevent handshake hangs #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
raprav wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: bound connection acquisition with queryTimeout to prevent handshake hangs #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,24 +82,24 @@ A `queryTimeout` (in milliseconds) set here applies to **every** query run throu

#### Configuration params:

| Parameter | Description |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| user | The MySQL user to authenticate as. |
| password | The password of that MySQL user. |
| database | Name of the database to use for this connection. (Optional) |
| host | The hostname of the database you are connecting to. |
| port | The port number to connect to. (Default: 3306) |
| socketPath | The path to a unix domain socket to connect to. When used host and port are ignored. (Optional) |
| charset | The charset for the connection (collation). (Default: 'UTF8_GENERAL_CI') |
| timezone | The timezone configured on the MySQL server. (Default: 'local') |
| insecureAuth | Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false) |
| flags | Connection flags. More information [here](https://github.com/mysqljs/mysql#connection-flags). |
| multipleStatements | Allow multiple mysql statements per query. (Default: true) |
| connectTimeout | Milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 60000) |
| queryTimeout | Milliseconds before an unresponsive query is aborted with a timeout error. Prevents a hung query from blocking the chain forever — e.g. when the server silently drops an idle/pooled connection and mysql2 reports it only as a non-fatal "packets out of order" warning. Disabled by default (no timeout). Applies to every query of this executor and can be overridden per query in the plan. (Optional) |
| ssl/ca | SSL CA File (Optional) |
| ssl/cert | SSL CERT File (Optional) |
| ssl/key | SSL KEY File (Optional) |
| Parameter | Description |
| :----------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| user | The MySQL user to authenticate as. |
| password | The password of that MySQL user. |
| database | Name of the database to use for this connection. (Optional) |
| host | The hostname of the database you are connecting to. |
| port | The port number to connect to. (Default: 3306) |
| socketPath | The path to a unix domain socket to connect to. When used host and port are ignored. (Optional) |
| charset | The charset for the connection (collation). (Default: 'UTF8_GENERAL_CI') |
| timezone | The timezone configured on the MySQL server. (Default: 'local') |
| insecureAuth | Allow connecting to MySQL instances that ask for the old (insecure) authentication method. (Default: false) |
| flags | Connection flags. More information [here](https://github.com/mysqljs/mysql#connection-flags). |
| multipleStatements | Allow multiple mysql statements per query. (Default: true) |
| connectTimeout | Milliseconds before a timeout occurs during the initial connection to the MySQL server. (Default: 60000) |
| queryTimeout | Milliseconds before an unresponsive operation is aborted with a timeout error. It bounds both phases of the operation independently: the connection acquisition (connect + handshake, where mysql2 has no working timer once the first byte arrives) and the query execution itself. Prevents a hung connection or query from blocking the chain forever — e.g. when the server stalls mid-handshake or silently drops a connection and mysql2 reports it only as a non-fatal "packets out of order" warning. Disabled by default (no timeout). Applies to every query of this executor and can be overridden per query in the plan. (Optional) |
| ssl/ca | SSL CA File (Optional) |
| ssl/cert | SSL CERT File (Optional) |
| ssl/key | SSL KEY File (Optional) |

### Plan sample:

Expand Down
Loading