mariadb connect file: 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_file(file_...")
 
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|__EDIT_ME__}}
{{FuncDescription|Connect}}


{{FuncSyntax|mariadb_connect_file(file_name)}}
{{FuncSyntax|mariadb_connect_file(file_name)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|file_name|__EDIT_ME__}}
{{FuncParam|file_name|The file name with the mariaDB credentials.}}


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
AddEvent("OnPackageStart", function()
mariadb_log(SQL_LOGL)
 
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)
</syntaxhighlight>


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

Revision as of 09:52, 19 November 2019

mariadb connect file

Type: Function
Context: Server
Introduced: v1.0

NOTICE

This function is provided by the official MariaDB plugin.

Description

Connect

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

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

	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=2847"