DbPoll

This function checks the progress of a database query.

Syntax

table dbPoll ( handle queryHandle, int timeout[, bool multipleResults = false ] )

OOP Syntax Help! I don't understand this!

Method: queryHandle:poll(...)

Required Arguments

• queryHandle: A query handle previously returned from dbQuery
• timeout: How many milliseconds to wait for a result. Use 0 for an instant response (which may return nil). Use -1 to wait until a result is ready. Note: A wait here will freeze the entire server just like the executeSQL* functions

Optional Arguments

• multipleResults: Set to true to enable the return values from multiple statements

Returns

• nil: Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call dbFree)
• false: Returns false if the query string contained an error, the connection has been lost or the query handle is incorrect. This automatically frees the query handle, so you do not have to call dbFree.
  • This also returns two extra values: (See the example on how the retrieve them)
    • int: error code
    • string error message
• table: Returns a table when the query has successfully completed. This automatically frees the query handle, so you do not have to call dbFree.
  • This also returns extra values:
    • int: number of affected rows
    • int: last insert id

The table is of the format:

{
    { colname1=value1, colname2=value2, ... },
    { colname1=value3, colname2=value4, ... },
    ...
}

A subsequent table represents the next row.

[[{{{image}}}|link=|]]	Note: If a column contained a number it is returned as a number, this includes things which were stored as string but are numbers such as "1" would be returned as 1.

Example

This example waits until a result is ready:

local result = dbPoll ( qh, -1 )

This example shows the possible return values:

local result, num_affected_rows, last_insert_id = dbPoll ( qh, -1 )

if result == nil then
    outputConsole( "dbPoll result not ready yet" )
elseif result == false then
    local error_code,error_msg = num_affected_rows,last_insert_id
    outputConsole( "dbPoll failed. Error code: " .. tostring(error_code) .. "  Error message: " .. tostring(error_msg) )
else
    outputConsole( "dbPoll succeeded. Number of affected rows: " .. tostring(num_affected_rows) .. "  Last insert id: " .. tostring(last_insert_id) )
end

This example shows how to handle the result if the query selected data:

local result = dbPoll ( qh, -1 )

if result then
    for _, row in ipairs ( result ) do

        -- by using a second loop (use it if you want to get the values of all columns the query selected):
        for column, value in pairs ( row ) do
            -- column = the mysql column of the table in the query
            -- value = the value of that column in this certain row
        end
		
        -- or without a second loop (use it if you want to handle every value in a special way):
        outputChatBox ( row["column"] ) -- it will output the value of the column "column" in this certain row
    end
end

This example shows how to handle the result of a multiple statement query: (See dbConnect option multi_statements)

local multiResults = dbPoll ( qh, -1, true )

if multiResults then
    for sidx, statementResult in ipairs ( multiResults ) do
        local resultRows, numAffectedRows, lastInsertId = unpack(statementResult)
        for ridx, row in ipairs ( resultRows ) do
            for column, value in pairs ( row ) do
                outputDebugString( ""
                        .. " statement#" .. sidx
                        .. " row#" .. ridx
                        .. " column:" .. tostring(column)
                        .. " value:" .. tostring(value)
                        )
            end
        end
    end
end

Requirements

Minimum server version	1.1.1-9.03328
Minimum client version	n/a

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.1.1-9.03328" />

Changelog

Version	Description

1.3.4-9.05862

Added 'last insert id' return value

1.5.2-9.07972

Added 'multipleResults' argument

See Also

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