Skip to content

Commit

Permalink
Added documentation for timeout functions
Browse files Browse the repository at this point in the history
  • Loading branch information
FredyH committed Sep 15, 2024
1 parent 95f9750 commit 2d611f1
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2d611f1

Please sign in to comment.