Modules/MTA-MySQL/mysql query: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ Executes a query in the server and retreives the result. '''Important:''' It is '''strongly''' recommended to call mysql_free_result aft...)
 
mNo edit summary
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>
__NOTOC__
__NOTOC__
{{ModuleFunction|MTA-MySQL}}
Executes a query in the server and retreives the result.
Executes a query in the server and retreives the result.


  '''Important:''' It is '''strongly''' recommended to call [[Modules/MTA-MySQL/mysql_free_result|mysql_free_result]] after a query,
  '''IMPORTANT:''' It is '''strongly''' recommended to call [[Modules/MTA-MySQL/mysql_free_result|mysql_free_result]] after a query,
  specially if it returns some data. Query results can be automatically deleted by the lua garbage collector, so if you '''forget'''
  specially if it returns some data. Query results can be automatically deleted
to free a result it will be freed at some time in the future, but it doesn't know the real result data size in memory so it can
by the lua garbage collector, so if you '''forget''' to free a result it will be
delay the memory destroying more than it should.
freed at some time in the future, but it doesn't know the real result data size
in memory so it can delay the memory destroying more than it should.


==Syntax==
==Syntax==

Latest revision as of 17:45, 5 January 2011


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

Executes a query in the server and retreives the result. 

IMPORTANT: It is strongly recommended to call mysql_free_result after a query,
specially if it returns some data. Query results can be automatically deleted
by the lua garbage collector, so if you forget to free a result it will be
freed at some time in the future, but it doesn't know the real result data size
in memory so it can delay the memory destroying more than it should.

Syntax

MySQLResult mysql_query ( MySQLConnection handler, string query )

Required arguments

  • handler: A valid MySQL link
  • query: The executing query

Returns

In case of error this function returns nil. IF not, a MySQLResult handler. Check the MySQL result managing functions to see how to retreive the data from it.

Example

Example 1: 

local result = mysql_query(handler, "SELECT * FROM some_table")
if (not result) then
  outputDebugString("Error executing the query: (" .. mysql_errno(handler) .. ") " .. mysql_error(handler))
else
  mysql_free_result(result) -- Freeing the result is IMPORTANT
end

See also

Result managing functions

MySQL handler functions

Retrieved from "https://wiki.multitheftauto.com/wiki/Modules/MTA-MySQL/mysql_query?oldid=24959"