mariadb await query: 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_await_query(handle..." |
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| | {{FuncDescription|Executes a query immediately blocking the main thread until it completes execution. You should use [[mariadb_query]] most of the times.}} | ||
{{FuncSyntax|mariadb_await_query(handle_id, query_str [, | {{FuncSyntax|mariadb_await_query(handle_id, query_str [, use_result])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|handle_id| | {{FuncParam|handle_id|Connection handle.}} | ||
{{FuncParam|query_str | | {{FuncParam|query_str|Query to execute.}} | ||
{{FuncParamOptional| | {{FuncParamOptional|use_result|Defaults to '''true'''. Set this to '''false''' if you are not interested in the results of the query.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns the active result set of the query executed. You must call [[mariadb_delete_result]] after you are done with the query to free the returned result set.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
function OnPackageStart() | |||
local result = mariadb_query(sql, "SELECT name FROM server") | |||
if mariadb_get_row_count() ~= 0 then | |||
print(mariadb_get_value_index(1, 1)) | |||
end | |||
mariadb_delete_result(result) | |||
end | |||
AddEvent("OnPackageStart", OnPackageStart) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
__EDIT_ME__ | __EDIT_ME__ | ||
Revision as of 08:25, 30 August 2019
Description
Executes a query immediately blocking the main thread until it completes execution. You should use mariadb_query most of the times.
Syntax
mariadb_await_query(handle_id, query_str [, use_result])
Parameters
- handle_id
Connection handle. - query_str
Query to execute. - use_result (optional)
Defaults to true. Set this to false if you are not interested in the results of the query.
Return Value
- Returns the active result set of the query executed. You must call mariadb_delete_result after you are done with the query to free the returned result set.
Example
function OnPackageStart()
local result = mariadb_query(sql, "SELECT name FROM server")
if mariadb_get_row_count() ~= 0 then
print(mariadb_get_value_index(1, 1))
end
mariadb_delete_result(result)
end
AddEvent("OnPackageStart", OnPackageStart)
See also
__EDIT_ME__
