mariadb connect

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
mariadb connect

Type: Function
Context: Server
Introduced: v1.0

NOTICE

This function is provided by the official MariaDB plugin.

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