mariadb connect file: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
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|Connect}}
{{FuncDescription|Connect using configuration from a file.}}


{{FuncSyntax|mariadb_connect_file(file_name)}}
{{FuncSyntax|mariadb_connect_file(file_name)}}
Line 12: Line 12:


== Example ==
== Example ==
sql_config.txt:
<pre>
hostname = 127.0.0.1:3306
username = myuser
password = 1234
database = mydb
</pre>
<syntaxhighlight lang="Lua">
<syntaxhighlight lang="Lua">
AddEvent("OnPackageStart", function()
AddEvent("OnPackageStart", function()
mariadb_log(SQL_LOGL)
mariadb_log("debug")


sql = mariadb_connect_file("horizon/sql_config.txt")
sql = mariadb_connect_file("horizon/sql_config.txt")

Revision as of 09:25, 2 September 2020

mariadb connect file

Type: Function
Context: Server
Introduced: v1.0

NOTICE

This function is provided by the official MariaDB plugin.

Description

Connect using configuration from a file.

Syntax

mariadb_connect_file(file_name)

Parameters

  • file_name
    The file name with the mariaDB credentials.

Return Value

  • Returns an identifier/ handle to the new database connection. false on error.

Example

sql_config.txt: 

hostname = 127.0.0.1:3306
username = myuser
password = 1234
database = mydb

AddEvent("OnPackageStart", function()
	mariadb_log("debug")

	sql = mariadb_connect_file("horizon/sql_config.txt")

	if (sql ~= false) then
		print("MariaDB: Connected.")
	else
		print("MariaDB: Connection failed. 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_file&oldid=4296"