mariadb await query

From Onset Developer Wiki
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