This function frees a database query handle. dbFree only needs to be used if a result has not been obtained with dbPoll.

OOP Syntax Help! I don't understand this!

• Method:db-query:free(...)

Syntax

bool dbFree ( db-query queryHandle )

Required Arguments

• queryHandle: A query handle previously returned from dbQuery.

Returns

• bool: result

Returns true if the handle was successfully freed, false otherwise.

Code Examples

Example 1 Example 2 Example 3 Example 4 Example 5 Example 6 (OOP)

server

Required because dbPoll was not called.

local qh = dbQuery(connection, "SELECT * FROM table_name")
dbFree(qh)

server

Required because dbPoll was not called.

function aaa()
    dbQuery(myCallback, connection, "SELECT * FROM table_name")
end

function myCallback(qh)
    dbFree(qh)
end

server

Required because dbPoll is called, but the result was not ready and no more attempts will be made.

local qh = dbQuery(connection, "SELECT * FROM table_name")
local result = dbPoll(qh, 10) -- Get result with a timeout of 10ms
if result == nil then
    result = dbPoll(qh, 10) -- Try again to get result with a timeout of 10ms
    if result == nil then
        dbFree(qh) -- Give up
    end
end

server

This example show when dbFree should NOT be used.

Not required because dbPoll was called with a -1 timeout.

local qh = dbQuery(connection, "SELECT * FROM table_name")
local result = dbPoll(qh, -1) -- Wait until result has been gotten

server

This example show when dbFree should NOT be used.

Not required because dbPoll was called from the callback.

function aaa()
    dbQuery(myCallback, connection, "SELECT * FROM table_name")
end

function myCallback(qh)
    local result = dbPoll(qh, 0) -- Timeout doesn't matter here because the result will always be ready
end

server

OOP Required

Required because dbPoll was not called.

local qh = connection:query("SELECT * FROM table_name")
qh:free()

See Also

Database Functions

• dbConnect
• dbExec
• dbFree
• dbPoll
• dbPrepareString
• dbQuery
• executeSQLQuery

Reference

• Scripting Functions