ExecuteSQLInsert: Difference between revisions

Latest revision as of 16:24, 13 February 2015

	This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
	Please use executeSQLQuery instead. See the examples at executeSQLQuery for equivalent INSERT usage.

This function adds a row in the database.

The SQLite database contains globally stored data and can be used by scripts to store and retrieve data in a structured manner.

The executed SQL query is the following:

[sql]INSERT INTO <table> <columns> VALUES <values>

Syntax

bool executeSQLInsert ( string tableName, string values, ( [string columns] ) )

Required Arguments

tableName: The name of the table you want to modify.
values: The values that need to be inserted for each field in the table. The ' character is used to specify a value and , is used as a delimiter for multiple values (e.g. 'value1','value2','value3' . The value order corresponds to either the default column order in the table, or the optional column argument (see below).

Optional Arguments

columns: The columns where the values will be stored into. This corresponds with the given value order (your first column will be set to the first specified value, the second column to the second value, ...) and should be separated by the , delimiter.

Returns

The function returns true on success, and false on failure.

Example

This example creates a SQL table when a map loads, and stores info about a player to that database when he spawns.

function onMapLoad ()
	-- create our table, if it doesn't already exist
	executeSQLCreateTable ( "players", "clothes_head_texture TEXT, clothes_head_model TEXT, player TEXT" )
end
addEventHandler ( "onGamemodeMapStart", getRootElement(), onMapLoad )

function addInfoToSQL( theSpawnpoint, theTeam )	
	local sourcename = getPlayerName ( source )         -- get the player's name
	
	-- try to retrieve the player data from the db
	result = executeSQLSelect ( "players", "player", "player = '" .. sourcename .. "'" )
	if ( result == false ) then	-- see if any data was found at all
		outputChatBox ( "This is your first time here! Welcome " .. sourcename .. "!", source )
		executeSQLInsert ( "players", "'none', 'none', '" .. sourcename .. "'" )
	else
		outputChatBox ( "Welcome back " .. sourcename .. "!", source )
		executeSQLUpdate ( "players", "clothes_head_texture = 'hairgreen', clothes_head_model = 'somehead'",
		"player = '" .. sourcename .. "'" )
	end	
	
	-- get the clothes data for the player
	result = executeSQLSelect ( "players", "clothes_head_texture, clothes_head_model", "player = '" .. sourcename .. "'" )
	outputChatBox ( "Your head texture is " .. result[1].clothes_head_texture )
	outputChatBox ( "Your head model is " .. result[1]['clothes_head_model'] )	
end
addEventHandler ( "onPlayerSpawn", getRootElement(), addInfoToSQL)

@@ Line 1: / Line 1: @@
 __NOTOC__
-This function adds a row in the registry. Since the registry is powered by a SQLite database, this function automatically executes an ''INSERT'' query with the appropriate parameters. This function can be used to add rows into the database that can later be modified by using the [[setRegistryQuery]] function.
+{{Server function}}
+{{Deprecated|executeSQLQuery|See the examples at executeSQLQuery for equivalent INSERT usage.}}
-The registry is stored globally and can be read from and written to by all scripts in sessions. This is useful if you want to store data for your script.
+This function adds a row in the database.
-The actual SQL query that is executed will be the following:
+The SQLite database contains globally stored data and can be used by scripts to store and retrieve data in a structured manner.
-<pre>INSERT INTO <table> VALUES <values></pre>
+The executed SQL query is the following:
+<syntaxhighlight lang="lua">[sql]INSERT INTO <table> <columns> VALUES <values></syntaxhighlight>
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool addRegistryQuery ( string table, string values )
+bool executeSQLInsert ( string tableName, string values, ( [string columns] ) )
 </syntaxhighlight>
 ===Required Arguments===
-*'''table:''' The table you want to modify.
+*'''tableName:''' The name of the table you want to modify.
-*'''values:''' The values that need to be inserted for each field in the table. The default SQL syntax is used, which means that the = is used to set a value, the ' is used to indicate a value and the , is used as a delimiter for multiple values (e.g. ''field1 = 'testA', field2 = 'testB' as values). Field names are optional. If you don't use field names, the table's order of fields is used (e.g. ''testA,testB'' as values).
+*'''values:''' The values that need to be inserted for each field in the table. The ' character is used to specify a value and , is used as a delimiter for multiple values (e.g. '' 'value1','value2','value3' ''. The value order corresponds to either the default column order in the table, or the optional column argument (see below).
+===Optional Arguments===
+*'''columns:''' The columns where the values will be stored into. This corresponds with the given value order (your first column will be set to the first specified value, the second column to the second value, ...) and should be separated by the , delimiter.
 ===Returns===
-The function returns a ''boolean'' which is ''true'' on success, and ''false'' on failure.
+The function returns ''true'' on success, and ''false'' on failure.
+==Example==
+This example creates a SQL table when a map loads, and stores info about a player to that database when he spawns.
+<syntaxhighlight lang="lua">
+function onMapLoad ()
+	-- create our table, if it doesn't already exist
+	executeSQLCreateTable ( "players", "clothes_head_texture TEXT, clothes_head_model TEXT, player TEXT" )
+end
+addEventHandler ( "onGamemodeMapStart", getRootElement(), onMapLoad )
+function addInfoToSQL( theSpawnpoint, theTeam )
+	local sourcename = getPlayerName ( source )         -- get the player's name
+	-- try to retrieve the player data from the db
+	result = executeSQLSelect ( "players", "player", "player = '" .. sourcename .. "'" )
+	if ( result == false ) then	-- see if any data was found at all
+		outputChatBox ( "This is your first time here! Welcome " .. sourcename .. "!", source )
+		executeSQLInsert ( "players", "'none', 'none', '" .. sourcename .. "'" )
+	else
+		outputChatBox ( "Welcome back " .. sourcename .. "!", source )
+		executeSQLUpdate ( "players", "clothes_head_texture = 'hairgreen', clothes_head_model = 'somehead'",
+		"player = '" .. sourcename .. "'" )
+	end
+	-- get the clothes data for the player
+	result = executeSQLSelect ( "players", "clothes_head_texture, clothes_head_model", "player = '" .. sourcename .. "'" )
+	outputChatBox ( "Your head texture is " .. result[1].clothes_head_texture )
+	outputChatBox ( "Your head model is " .. result[1]['clothes_head_model'] )
+end
+addEventHandler ( "onPlayerSpawn", getRootElement(), addInfoToSQL)
+</syntaxhighlight>
 ==See Also==
 {{Registry_functions}}