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
 
(3 intermediate revisions by 2 users not shown)
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|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 [, use_cache])}}
{{FuncSyntax|mariadb_await_query(handle_id, query_str [, use_result])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|handle_id|__EDIT_ME__}}
{{FuncParam|handle_id|Connection handle.}}
{{FuncParam|query_str |__EDIT_ME__}}
{{FuncParam|query_str|Query to execute.}}
{{FuncParamOptional|use_cache|__EDIT_ME__}}
{{FuncParamOptional|use_result|Defaults to '''true'''. Set this to '''false''' if you are not interested in the results of the query.}}


{{FuncReturnValue|__EDIT_ME__}}
{{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 ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function OnPackageStart()
    local result = mariadb_await_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__
{{MariaDBFunctions}}

Latest revision as of 09:21, 2 September 2020

mariadb await query

Type: Function
Context: Server
Introduced: v1.0

NOTICE

This function is provided by the official MariaDB plugin.

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_await_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

Retrieved from "https://dev.playonset.com/index.php?title=mariadb_await_query&oldid=4295"