Skip to content

Commit

Permalink
docs: add comment about a request lasting longer than its timeout (#1486
Browse files Browse the repository at this point in the history
)

docs: add a comment on how a sql query can have potential to run longer than the configured timeout

Co-authored-by: Adam S <adam.swanson@svtrobotics.com>
  • Loading branch information
AdamJohnSwan and AdamJohnSwan committed Jun 7, 2023
1 parent 9070fa3 commit ed02374
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,9 @@ export interface ConnectionOptions {
readOnlyIntent?: boolean;

/**
* The number of milliseconds before a request is considered failed, or `0` for no timeout
* The number of milliseconds before a request is considered failed, or `0` for no timeout.
*
* As soon as a response is received, the timeout is cleared. This means that queries that immediately return a response have ability to run longer than this timeout.
*
* (default: `15000`).
*/
Expand Down

0 comments on commit ed02374

Please sign in to comment.