From 2d611f19e66c42d7402dad486812105a5cab7599 Mon Sep 17 00:00:00 2001 From: FredyH Date: Mon, 16 Sep 2024 00:21:13 +0200 Subject: [PATCH] Added documentation for timeout functions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index abc5f69..bd64d7a 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,15 @@ Database:setSSLSettings(key, cert, ca, capath, cipher) -- Every parameter is optional and can be omitted (set to nil) if not required. -- See https://dev.mysql.com/doc/c-api/8.0/en/mysql-ssl-set.html for the description of each parameter. +Database:setReadTimeout(timeout) +Database:setWriteTimeout(timeout) +Database:setConnectTimeout(timeout) +-- Returns nothing +-- Sets the corresponding timeout value in seconds for any queries operations started by this database instance. +-- The timeout value needs to be at least 1. If this is not called, the default value is used. +-- For information about the timeout values read the documentation here: +-- https://dev.mysql.com/doc/c-api/8.0/en/mysql-options.html + -- Callbacks Database.onConnected( db ) -- Called when the connection to the MySQL server is successful