mariadb connect: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{Notice|This function is provided by the official MariaDB plugin.}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|mariadb_connect(host_str,..."
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
{{Notice|This function is provided by the official [[MariaDB]] plugin.}}
{{Notice|This function is provided by the official [[MariaDB]] plugin.}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Connect to the mariadb database.}}


{{FuncSyntax|mariadb_connect(host_str, user_str, passwd_str, db_str [, ssl_key_file, ssl_cert_file, ssl_ca_file, ssl_ca_path, ssl_cipher])}}
{{FuncSyntax|mariadb_connect(host_str, user_str, passwd_str, db_str [, ssl_key_file, ssl_cert_file, ssl_ca_file, ssl_ca_path, ssl_cipher])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|host_str|__EDIT_ME__}}
{{FuncParam|host_str|The MariaDB server to connect to. This can be an IP address or hostname.}}
{{FuncParam|user_str|__EDIT_ME__}}
{{FuncParam|user_str|The MariaDB user.}}
{{FuncParam|passwd_str|__EDIT_ME__}}
{{FuncParam|passwd_str|The password for the user.}}
{{FuncParam|db_str |__EDIT_ME__}}
{{FuncParam|db_str |MariaDB database to use.}}
{{FuncParam|ssl_key_file|__EDIT_ME__}}
{{FuncParamOptional|ssl_key_file|Private key for SSL connections.}}
{{FuncParam|ssl_cert_file|__EDIT_ME__}}
{{FuncParamOptional|ssl_cert_file|Certificate file for SSL connections.}}
{{FuncParam|ssl_ca_file|__EDIT_ME__}}
{{FuncParamOptional|ssl_ca_file|Path to the certificate authority file}}
{{FuncParam|ssl_ca_path|__EDIT_ME__}}
{{FuncParamOptional|ssl_ca_path|Path to the directory containing the trusted TLS CA certificates in PEM format. }}
{{FuncParamOptional|ssl_cipher|__EDIT_ME__}}
{{FuncParamOptional|ssl_cipher|List of permitted ciphers to use for TLS encryption.


{{FuncReturnValue|__EDIT_ME__}}
    TLSv1.0
    TLSv1.1
    TLSv1.2
    TLSv1.3 }}
 
{{FuncReturnValue|Returns an identifier/handle to the new database connection. '''false''' on error.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
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)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:MariaDBFunctions}}

Latest revision as of 09:29, 2 September 2020

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

Retrieved from "https://dev.playonset.com/index.php?title=mariadb_connect&oldid=4297"