mariadb connect: Difference between revisions
From Onset Developer Wiki
No edit summary |
No edit summary |
||
Line 12: | Line 12: | ||
{{FuncParam|db_str |MariaDB database to use.}} | {{FuncParam|db_str |MariaDB database to use.}} | ||
{{FuncParamOptional|ssl_key_file|Private key for SSL connections.}} | {{FuncParamOptional|ssl_key_file|Private key for SSL connections.}} | ||
{{FuncParamOptional|ssl_cert_file| | {{FuncParamOptional|ssl_cert_file|Certificate file for SSL connections.}} | ||
{{FuncParamOptional|ssl_ca_file| | {{FuncParamOptional|ssl_ca_file|Path to the certificate authority file}} | ||
{{FuncParamOptional|ssl_ca_path| | {{FuncParamOptional|ssl_ca_path|Path to the directory containing the trusted TLS CA certificates in PEM format. }} | ||
{{FuncParamOptional|ssl_cipher| | {{FuncParamOptional|ssl_cipher|List of permitted ciphers to use for TLS encryption. | ||
TLSv1.0 | |||
TLSv1.1 | |||
TLSv1.2 | |||
TLSv1.3 }} | |||
{{FuncReturnValue|Returns an identifier/handle to the new database connection. '''false''' on error.}} | {{FuncReturnValue|Returns an identifier/handle to the new database connection. '''false''' on error.}} |
Latest revision as of 09:29, 2 September 2020
Description
Connect to the mariadb database.
Syntax
mariadb_connect(host_str, user_str, passwd_str, db_str [, ssl_key_file, ssl_cert_file, ssl_ca_file, ssl_ca_path, ssl_cipher])
Parameters
- host_str
The MariaDB server to connect to. This can be an IP address or hostname. - user_str
The MariaDB user. - passwd_str
The password for the user. - db_str
MariaDB database to use. - ssl_key_file (optional)
Private key for SSL connections. - ssl_cert_file (optional)
Certificate file for SSL connections. - ssl_ca_file (optional)
Path to the certificate authority file - ssl_ca_path (optional)
Path to the directory containing the trusted TLS CA certificates in PEM format. - ssl_cipher (optional)
List of permitted ciphers to use for TLS encryption.
TLSv1.0 TLSv1.1 TLSv1.2 TLSv1.3
Return Value
- Returns an identifier/handle to the new database connection. false on error.
Example
AddEvent("OnPackageStart", function()
local SQL_HOST = "localhost"
local SQL_PORT = 3306
local SQL_USER = "user"
local SQL_PASS = "password"
local SQL_DATA = "database"
local SQL_CHAR = "utf8mb4"
local SQL_LOGL = "debug"
mariadb_log(SQL_LOGL)
sql = mariadb_connect(SQL_HOST .. ':' .. SQL_PORT, SQL_USER, SQL_PASS, SQL_DATA)
if (sql ~= false) then
print("MariaDB: Connected to " .. SQL_HOST)
mariadb_set_charset(sql, SQL_CHAR)
else
print("MariaDB: Connection failed to " .. SQL_HOST .. ", see mariadb_log file")
-- Immediately stop the server if we cannot connect
ServerExit()
end
end)
See also
- OnQueryError
- mariadb_log
- mariadb_connect
- mariadb_connect_file
- mariadb_close
- mariadb_unprocessed_queries
- mariadb_async_query
- mariadb_query
- mariadb_await_query
- mariadb_query_file
- mariadb_await_query_file
- mariadb_errno
- mariadb_error
- mariadb_escape_string
- mariadb_prepare
- mariadb_set_charset
- mariadb_get_charset
- mariadb_stat
- mariadb_get_row_count
- mariadb_get_field_count
- mariadb_get_result_count
- mariadb_get_field_name
- mariadb_set_result
- mariadb_get_value_index
- mariadb_get_value_index_int
- mariadb_get_value_index_float
- mariadb_get_value_name
- mariadb_get_value_name_int
- mariadb_get_value_name_float
- mariadb_save_result
- mariadb_delete_result
- mariadb_set_active_result
- mariadb_unset_active_result
- mariadb_is_any_result_active
- mariadb_is_valid_result
- mariadb_get_affected_rows
- mariadb_get_warning_count
- mariadb_get_insert_id
- mariadb_get_query_exec_time
- mariadb_get_query_string
- mariadb_get_row
- mariadb_get_assoc