ExecuteSQLQuery: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 66549 by Abdo Nour (talk))
Tag: Undo
(Undo revision 66548 by Abdo Nour (talk))
Tag: Undo
 
Line 32: Line 32:
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.
Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.


مثال لعمل جدول جديد:
Example equivalents for executeSQLCreateTable:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)") -- اذا لا يوجد جدول بنفس الإسم يصنع جدول بإسم players ويضع كولمن بداخل الجدول
executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)") -- اذا لا يوجد جدول بنفس الإسم يصنع جدول بإسم `players` ويضع كولمن بداخل الجدول
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")
</syntaxhighlight>
</syntaxhighlight>


مثال لحذف رو من الجدول:
Example equivalents for executeSQLDelete:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
playerName = getPlayerName(thePlayer) -- إحضار اسم اللاعب
playerName = getPlayerName(thePlayer)
executeSQLQuery("DELETE FROM players WHERE name=?", playerName) -- حذف الرو الخاص باللاعب المعرف بالكولمن name من خلال اسمه
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName) -- حذف الرو الخاص اللاعب المعرف بالكولمن `name` من خلال اسمه
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)
</syntaxhighlight>
</syntaxhighlight>


مثال لحذف الجدول بالكامل:
Example equivalents for executeSQLDropTable:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
executeSQLQuery("DROP TABLE players" ) -- حذف الجدول المسمي بـ players
executeSQLQuery("DROP TABLE players" )
executeSQLQuery("DROP TABLE `players`" ) -- حذف الجدول المسمي بـ `players`
executeSQLQuery("DROP TABLE `players`" )
</syntaxhighlight>
</syntaxhighlight>


Example equivalents for executeSQLSelect:
Example equivalents for executeSQLSelect:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
playerName = getPlayerName(thePlayer) -- إحضار اسم اللاعب
playerName = getPlayerName(thePlayer)
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName ) -- الحصول علي المعلومات المخزنة التي تحتوي علي نقاط ودم اللاعب من خلال اسمه المعرف بجدول players وبكولمن name
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName ) -- الحصول علي المعلومات المخزنة التي تحتوي علي نقاط ودم اللاعب من خلال اسمه المعرف بجدول `players` وبكولمن `name`
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )
</syntaxhighlight>
</syntaxhighlight>


مثال لوضع رو جديد بالكولمن:
Example equivalents for executeSQLInsert:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
playerName = getPlayerName(thePlayer) -- احضار اسم اللاعب
playerName = getPlayerName(thePlayer)
colorName = "Blue" -- لون الإسم
colorName = "Blue"
soundName = "sound.mp3" -- الصوت الخاص بالإسم
soundName = "sound.mp3"
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName ) -- اختيار الجدول players ووضع رو الاسم بكولمن name ووضع رو اللون بكولمن color ووضع رو الصوت بكولمن sound.
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName ) -- اختيار الجدول `players` ووضع رو الاسم بكولمن `name` ووضع رو اللون بكولمن `color` ووضع رو الصوت بكولمن `sound`.
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )
</syntaxhighlight>
</syntaxhighlight>


مثال لتحديث معلومات رو معين بالكولمن:
Example equivalents for executeSQLUpdate:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
playerName = getPlayerName(thePlayer) -- اسم اللاعب
playerName = getPlayerName(thePlayer)
colorName = "Blue" -- لون الاسم
colorName = "Blue"
soundName = "sound.mp3" -- الصوت الخاص بالاسم
soundName = "sound.mp3"
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName ) -- تحديث الرو الخاص بإسم اللاعب وتعريف المعلومات عن طريق كتابة التعريف بجانب كل كولمن ليتم حفظه في رو اللاعب
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName ) -- تحديث الرو الخاص بإسم اللاعب وتعريف المعلومات عن طريق المعلومات التي جلبناها من قبل فوق
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName ) -- تحديث الرو الخاص بإسم اللاعب ولكن بجدول وكولمن مختلف
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )
</syntaxhighlight>
</syntaxhighlight>




هذا المثال يعرض قائمة اللاعبين المسجلين في قاعدة البيانات والذين لدليهم اكثر عدد من المال.
This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function listPlayersWithMoreMoneyThan(thePlayer, command, amount) -- عمل وظيفة
function listPlayersWithMoreMoneyThan(thePlayer, command, amount)
     local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount)) -- اختيار اسم اللاعب من خلال اكثر عدد من المال المسجل في القاعدة وتعريفها بإسم players ليتم جلبها فيما بعد
     local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))
     outputConsole("Players with more money than " .. amount .. ":", thePlayer)
     outputConsole("Players with more money than " .. amount .. ":", thePlayer)
     for i, playerdata in ipairs(players) do -- اختيار معلومات اللاعب من القاعدة المعرفة بإسم players
     for i, playerdata in ipairs(players) do
         outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer) -- اظهار رقم الرو و اسم اللاعب في اف8
         outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)
     end
     end
end
end


addCommandHandler("richplayers", listPlayersWithMoreMoneyThan) -- كتابة الامر rechplayers لتشغيل الوظيفة
addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)
</syntaxhighlight>
</syntaxhighlight>


Line 96: Line 96:


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function showPlayerMoney(thePlayer, command, playerName) -- عمل وظيفة
function showPlayerMoney(thePlayer, command, playerName)
     local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName) -- جلب عدد المال من قاعدة players من خلال الاسم
     local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)
     if(#result == 0) then -- نتأكد اذا الجدول = 0
     if(#result == 0) then
         outputConsole("No player named " .. playerName .. " is registered.", thePlayer) -- يرسل ب اف8 للاعب ان اسم اللاعب ليس مسجل
         outputConsole("No player named " .. playerName .. " is registered.", thePlayer)
     else -- اذا الجدول لا يساوي 0
     else
         outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer) -- يكتب اسم اللاعب وعدد المال المسجل في القاعده لديه
         outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)
     end -- انهاء التحقق
     end
end -- انهاء الوظيفة
end
addCommandHandler("playermoney", showPlayerMoney) -- كتابة الامر playermoney لتشغيل الوظيفة
addCommandHandler("playermoney", showPlayerMoney)
</syntaxhighlight>
</syntaxhighlight>


Line 110: Line 110:


The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.
The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.
By: [Abdo Nour]


==See Also==
==See Also==

Latest revision as of 21:33, 15 May 2020

This function executes an arbitrary SQL query and returns the result rows if there are any. It allows parameter binding for security (SQL injection is rendered impossible).

[[{{{image}}}|link=|]] Note: This function only acts upon registry.db. Use dbQuery to query a custom SQL database.

Syntax

table executeSQLQuery ( string query [, var param1 [, var param2 ... ] ] )

Required Arguments

  • query: An SQL query. Positions where parameter values will be inserted are marked with a "?".

Optional Arguments

  • paramX: A variable number of parameters. These must be strings or numbers - it is important to make sure they are of the correct type. Also, the number of parameters passed must be equal to the number of "?" characters in the query string.

String parameters are automatically escaped by adding a backslash (\) before ' and \ characters.

Returns

Returns a table with the result of the query if it was a SELECT query, or false if otherwise. In case of a SELECT query the result table may be empty (if there are no result rows). The table is of the form:

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

A subsequent table represents the next row.

Example

Below are examples of equivalents for the deprecated executeSQL functions. Note that ` (backtick) can optionally be used to surround table and row names. It usually a good idea to do this to avoid name clashes with SQL reserved words.

Example equivalents for executeSQLCreateTable:

executeSQLQuery("CREATE TABLE IF NOT EXISTS players (clothes_head_texture TEXT, clothes_head_model TEXT, name TEXT)")
executeSQLQuery("CREATE TABLE IF NOT EXISTS `players` (`clothes_head_texture` TEXT, `clothes_head_model` TEXT, `name` TEXT)")

Example equivalents for executeSQLDelete:

playerName = getPlayerName(thePlayer)
executeSQLQuery("DELETE FROM players WHERE name=?", playerName)
executeSQLQuery("DELETE FROM `players` WHERE `name`=?", playerName)

Example equivalents for executeSQLDropTable:

executeSQLQuery("DROP TABLE players" )
executeSQLQuery("DROP TABLE `players`" )

Example equivalents for executeSQLSelect:

playerName = getPlayerName(thePlayer)
executeSQLQuery("SELECT score,health FROM players WHERE name=?", playerName )
executeSQLQuery("SELECT `score`,`health` FROM `players` WHERE `name`=?", playerName )

Example equivalents for executeSQLInsert:

playerName = getPlayerName(thePlayer)
colorName = "Blue"
soundName = "sound.mp3"
executeSQLQuery("INSERT INTO players(name,color,sound) VALUES(?,?,?)", playerName, colorName, soundName )
executeSQLQuery("INSERT INTO `players`(`name`,`color`,`sound`) VALUES(?,?,?)", playerName, colorName, soundName )

Example equivalents for executeSQLUpdate:

playerName = getPlayerName(thePlayer)
colorName = "Blue"
soundName = "sound.mp3"
executeSQLQuery("UPDATE players SET color='green',sound='somehead' WHERE name=?", playerName )
executeSQLQuery("UPDATE players SET color=?,sound=? WHERE name=?", colorName, soundName, playerName )
executeSQLQuery("UPDATE `players` SET `color`=?,`sound`=? WHERE `name`=?", colorName, soundName, playerName )


This example defines a console command that shows the ID's and names of all registered (stored in database) players that have more than the specified amount of money.

function listPlayersWithMoreMoneyThan(thePlayer, command, amount)
    local players = executeSQLQuery("SELECT id, name FROM players WHERE money > ?", tonumber(amount))
    outputConsole("Players with more money than " .. amount .. ":", thePlayer)
    for i, playerdata in ipairs(players) do
        outputConsole(playerdata.id .. ": " .. playerdata.name, thePlayer)
    end
end

addCommandHandler("richplayers", listPlayersWithMoreMoneyThan)


This example shows the amount of money a certain registered player has.

function showPlayerMoney(thePlayer, command, playerName)
    local result = executeSQLQuery("SELECT money FROM players WHERE name=?", playerName)
    if(#result == 0) then
        outputConsole("No player named " .. playerName .. " is registered.", thePlayer)
    else
        outputConsole("Money amount of player " .. playerName .. " is " .. result[1].money, thePlayer)
    end
end
addCommandHandler("playermoney", showPlayerMoney)

Notice the lack of single quotes around the "?" in this example, even though it represents a string. executeSQLQuery will see that the playerName variable is a string and take care of the correct execution of the query by itself.

The advantage of using executeSQLQuery is that it is immune to users trying to exploit the query with an SQL injection attack. playerName may contain special characters like ', " or -- that will not influence the query, unlike the older approach where playerName would be concatenated into the query string.

See Also