Modules/MySQL/MysqlOpen

Description

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 (hopefully) read/write to the database by using the mysqlQuery function.

This function is provided by the ml_mysql module.

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 )
    -- connection succeeded. switch some global boolean or do a query
  else
    -- panic.
  end
end
<...>
mysqlOpen ( "onMySQLOpen", "localhost", "user123", "mypassword", "testdatabase", 3306 );