Modules/MySQL/MysqlOpen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (MysqlOpen moved to Modules/MySQL/MysqlOpen)
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{ModuleFunction|MySQL}}
This function opens a MySQL connection to a specific database on a database server. As soon as a connection is made (or timed out), the callback_function you passed as parameter is called and you can read/write to the database by using the [[mysqlQuery]] function.
This function opens a MySQL connection to a specific database on a database server. As soon as a connection is made (or timed out), the callback_function you passed as parameter is called and you can read/write to the database by using the [[mysqlQuery]] function.
This function is provided by the [[Module functions|ml_mysql]] module.


==Syntax==
==Syntax==

Revision as of 13:25, 1 November 2006


Package-x-generic.png This function is provided by the external module MySQL. You must install this module to use this function.


This function opens a MySQL connection to a specific database on a database server. As soon as a connection is made (or timed out), the callback_function you passed as parameter is called and you can read/write to the database by using the mysqlQuery function.

Syntax

bool mysqlOpen ( string callback_function, string host, string user, string password, string database_name, int port )

Required Arguments

  • callback_function : The function that is called if the operation is done (please see below)
  • host : The database server hostname or IP address to use
  • user : The database username to use
  • password : The database password to use
  • database_name : The database name to use
  • port : The database server port (MySQL default port is 3306)

Callback Arguments

Your callback function has to accept the following arguments:

  • mysql mysql : Returns the mysql object
  • bool result : Returns false on error, true on success

Optional Arguments

None

Example

function onMySQLOpen ( mysql, result )
	if ( result ) then
		outputServerLog ( "CONNECTED" )
	else
		outputServerLog ( "DIDNT WORK" )
	end
end

function mysqltest ()
	mysqlOpen ( "onMySQLOpen", "localhost", "bastage", "bastage_pw", "test", 3306 )
end