24 lines
978 B
Plaintext
24 lines
978 B
Plaintext
:sig
|
|
MySQL* mysql_connect(String host = "localhost", String username = "root", String password = "")
|
|
|
|
:params
|
|
host : host name of the MySQL server
|
|
username : user name
|
|
password : password
|
|
return value : pointer to the MySQL connection struct
|
|
|
|
:see
|
|
>mysql
|
|
|
|
:content
|
|
Establishes a connection to a MySQL server and returns a pointer to the connection struct.
|
|
|
|
This connection handle is then used with helpers such as `mysql_query()`, `mysql_error()`, and `mysql_disconnect()`.
|
|
|
|
MySQL handles are request-scoped framework resources. If a request exits without calling `mysql_disconnect()`, UCE closes any remaining MySQL handles during request cleanup. Call `mysql_disconnect()` when you want to close early, but never store a `MySQL*` in globals, sessions, or other state that can outlive the current request.
|
|
|
|
:example
|
|
MySQL* db = mysql_connect();
|
|
print(db != 0 ? "connected to MySQL" : "no MySQL server reachable with these credentials", "\n");
|
|
if(db != 0) mysql_disconnect(db);
|