DbPoll - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:34:58Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:34, 7 November 2024
Line 199:		Line 199:
	dbQuery(onServerQueryCallback, {"Some data"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", playerName)		dbQuery(onServerQueryCallback, {"Some data"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", playerName)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|1.1.1-9.03328\|n/a}}~~

	==Changelog==		==Changelog==

Srslyyyy: Add missing locals.

2023-01-11T23:01:20Z

Add missing locals.

Srslyyyy: Add missing locals & better naming.

2023-01-11T22:59:19Z

Add missing locals & better naming.

← Older revision		Revision as of 22:59, 11 January 2023
Line 80:		Line 80:
	This example shows how to print the results of the query:		This example shows how to print the results of the query:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~connection~~ = dbConnect("sqlite", "test.db")		local dbConnection = dbConnect("sqlite", "test.db")
	~~queryhandle~~ = dbQuery( ~~connection~~, 'SELECT * FROM Test1')		local queryHandle = dbQuery(dbConnection, "SELECT * FROM `Test1`")
	~~result~~ = dbPoll(~~queryhandle~~, -1)		local queryResult = dbPoll(queryHandle, -1)

	for ~~rid~~, ~~row~~ in ipairs (~~result~~) do ~~-- row represents the tables that are in 'result', which represent the rows~~		for rowID, rowData in ipairs(queryResult) do
	for ~~column~~, ~~value~~ in pairs (~~row~~) do ~~-- column represents column name, value represents column value~~
	outputChatBox(~~column~~..', '..~~value~~)		for columnName, columnValue in pairs(rowData) do
	end		outputChatBox(columnName..", "..columnValue)
			end
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Return early for last example.

2023-01-11T22:53:36Z

Return early for last example.

← Older revision		Revision as of 22:53, 11 January 2023
Line 178:		Line 178:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local dbConnection = dbConnect("sqlite", "sql.db")		local dbConnection = dbConnect("sqlite", "sql.db")
			local playerName = "testPlayer"

	function ~~onServerCallback~~(queryHandler, extraData)		function onServerQueryCallback(queryHandler, extraData)
	local queryResult = dbPoll(queryHandler, 0)		local queryResult = dbPoll(queryHandler, 0)
			local validResult = type(queryResult) == "table"

	~~print~~(extraData)		outputDebugString("Extra data which have been passed through dbQuery:", extraData)

	if ~~type(queryResult) == "table"~~ then		if not validResult then
	~~print~~("~~queryResult =~~= table")		outputDebugString("Result ~= table")

	~~if #queryResult > 0 then~~		return false
	~~print("#queryResult > 0")~~
	~~else~~
	~~print("#queryResult == 0")~~
	~~end~~
	~~else~~
	~~print("queryResult ~= table")~~
	end		end

			outputDebugString("Query results:", queryResult)
	end		end

	~~local playerName = "testPlayer"~~		dbQuery(onServerQueryCallback, {"Some data"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", playerName)

	dbQuery(~~onServerCallback~~, {"~~Extra~~ data"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", playerName)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Improve example.

2021-12-25T22:44:55Z

Improve example.

← Older revision		Revision as of 22:44, 25 December 2021
Line 197:		Line 197:
	end		end

	dbQuery(onServerCallback, {"Extra data :)"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", "playerName")		local playerName = "testPlayer"

			dbQuery(onServerCallback, {"Extra data"}, dbConnection, "SELECT * FROM `Players` WHERE `playerName` = ?", playerName)
	</syntaxhighlight>		</syntaxhighlight>

Srslyyyy: Fix comment.

2020-08-22T02:33:56Z

Fix comment.

← Older revision		Revision as of 02:33, 22 August 2020
Line 190:		Line 190:
	print("#queryResult > 0")		print("#queryResult > 0")
	else		else
	print("#queryResult < 0")		print("#queryResult == 0")
	end		end
	else		else

Srslyyyy: Added note about async.

2020-08-12T00:42:57Z

Added note about async.

← Older revision		Revision as of 00:42, 12 August 2020
Line 11:		Line 11:
	*'''queryHandle:''' A query handle previously returned from [[dbQuery]]		*'''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 executeSQLQuery		*'''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 executeSQLQuery
			{{Important Note\|It is strongly recommended to use this function in callback, as presented in "This example shows how to obtain data without server freeze."}}

	===Optional Arguments===		===Optional Arguments===

Srslyyyy: Added async example.

2020-08-12T00:38:36Z

Added async example.

@@ Line 173: / Line 173: @@
 </syntaxhighlight>
 |7972}}
 ==Requirements==

Danilo: updated old information

2020-07-04T00:53:08Z

updated old information

← Older revision		Revision as of 00:53, 4 July 2020
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''queryHandle:''' A query handle previously returned from [[dbQuery]]		*'''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~~		*'''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 executeSQLQuery

	===Optional Arguments===		===Optional Arguments===

Myonlake: /* Optional Arguments */

2018-07-22T22:38:26Z

Optional Arguments

← Older revision		Revision as of 22:38, 22 July 2018
Line 13:		Line 13:

	===Optional Arguments===		===Optional Arguments===
	{{New items\|3.~~0160~~\|1.5.2\|		{{New items\|3.0152\|1.5.2\|
	*'''multipleResults:''' Set to true to enable the return values from multiple queries		*'''multipleResults:''' Set to true to enable the return values from multiple queries
	\|7972}}		\|7972}}

← Older revision		Revision as of 23:01, 11 January 2023
Line 94:		Line 94:
	This is another example of printing the results:		This is another example of printing the results:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	connection = dbConnect("sqlite", "test.db")		local connection = dbConnect("sqlite", "test.db")
	queryhandle = dbQuery( connection, 'SELECT * FROM Test1')		local queryhandle = dbQuery(connection, 'SELECT * FROM Test1')
	result = dbPoll(queryhandle, -1)		local result = dbPoll(queryhandle, -1)

	for rid, row in ipairs (fromJSON(toJSON(result))) do -- row represents the tables that are in 'result', which represent the rows		for rid, row in ipairs (fromJSON(toJSON(result))) do -- row represents the tables that are in 'result', which represent the rows
Line 107:		Line 107:
	This is another example of printing the results:		This is another example of printing the results:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	connection = dbConnect("sqlite", "test.db")		local connection = dbConnect("sqlite", "test.db")
	queryhandle = dbQuery( connection, 'INSERT INTO Test1 ("Name1", "Name2") VALUES ("Hello", "Hi");')		local queryhandle = dbQuery( connection, 'INSERT INTO Test1 ("Name1", "Name2") VALUES ("Hello", "Hi");')
	result = dbPoll(queryhandle, -1)		local result = dbPoll(queryhandle, -1)

	outputChatBox(toJSON(result)) -- Shows only rowid 1 affected because we only used INSERT INTO statement and not a SELECT statement.		outputChatBox(toJSON(result)) -- Shows only rowid 1 affected because we only used INSERT INTO statement and not a SELECT statement.

Line 122:		Line 123:
	This is another example of printing the results:		This is another example of printing the results:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	connection = dbConnect("sqlite", "test.db")		local connection = dbConnect("sqlite", "test.db")
	queryhandle = dbQuery( connection, 'INSERT INTO Test1 (Name1) VALUES ("Hello"); SELECT * FROM Test1')		local queryhandle = dbQuery( connection, 'INSERT INTO Test1 (Name1) VALUES ("Hello"); SELECT * FROM Test1')
	multiResults = dbPoll(queryhandle, -1)		local multiResults = dbPoll(queryhandle, -1)

	for sid, statementResult in ipairs ( multiResults ) do		for sid, statementResult in ipairs ( multiResults ) do
Line 138:		Line 139:
	This is another example of printing the results:		This is another example of printing the results:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	connection = dbConnect("sqlite", "test.db")		local connection = dbConnect("sqlite", "test.db")
	queryhandle = dbQuery( connection, 'INSERT INTO Test1 (Name1) VALUES ("Hello"); SELECT * FROM Test1')		local queryhandle = dbQuery( connection, 'INSERT INTO Test1 (Name1) VALUES ("Hello"); SELECT * FROM Test1')
	multiResults = dbPoll(queryhandle, -1)		local multiResults = dbPoll(queryhandle, -1)

	for sid, statementResult in ipairs ( multiResults ) do		for sid, statementResult in ipairs ( multiResults ) do