RanXerox: added categories

2010-11-06T18:32:05Z

added categories

MrSugarCube at 15:45, 1 August 2009

2009-08-01T15:45:08Z

MrSugarCube: Created page with ''''''wip''''' FORCETOC ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to comple...'

2009-08-01T15:44:48Z

Created page with ''''''wip''''' __FORCETOC__ ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to comple...'

New page

'''''wip'''''

__FORCETOC__

==Description==
This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to complete like the [[EXECUTE]] function). Once the query has been executed, a specified callback function will run.

'''''Note 1''''': An open database connection is required for this function to work correctly. See the [[CONNECT]] function for information regarding the opening of a database connection.

'''''Note 2''''': The [[AEXECUTE]] and [[EXECUTE]] functions are intended to run SQL commands that do not return any results (such as DELETE or UPDATE). For commands that return results (that you want to then read back) see the [[AQUERY]] and [[QUERY]] functions.

Valid for the following objects:
* [[Database]]

==Syntax==
<tt>AEXECUTE ''function'', ''command''</tt>

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''Type''' || '''Description'''
|-
| ''function'' || string || A script function to call when the command has been executed.
{| cellspacing="4" cellpadding="4"
| '''Argument''' || '''Description'''
|-
| ''ARGN1'' || The type of command (0 = [[AEXECUTE]], 1 = [[AQUERY]])
|-
| ''ARGN2'' || 0 = Command failed, 1 = Command succeeded.
|-
| ''ARGS'' || The command that was executed.
|}
|-
| ''command'' || string || The SQL command to execute.
|}

==Return Values==
This function returns one of two values when executed. See the table below for the meanings of the return values:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Command has not been successfully queued.
|-
| 1 || Command has been successfully queued.
|}

==Examples==

<spherescript>
//
// Queues up an SQL command.
//
[FUNCTION f_execute]
SERV.LOG Deleting all rows from table 'tbl_name'.
IF (<DB.AEXECUTE f_execute_callback, DELETE FROM tbl_name> == 0)
SERV.LOG Failed to queue command.
ELSE
SERV.LOG Command queued.
ENDIF
RETURN

//
// This function will be called when the query has been executed.
//
[FUNCTION f_execute_callback]
IF (<ARGN2> == 0)
SERV.LOG The command failed to execute. (<ARGS>)
ELSE
SERV.LOG The command succeeded. (<ARGS>)
ENDIF
RETURN
</spherescript>

← Older revision		Revision as of 18:32, 6 November 2010
Line 74:		Line 74:
	RETURN		RETURN
	</spherescript>		</spherescript>
		+
		+	[[Category: Reference Compendium]]
		+	[[Category: Properties and Functions]]

← Older revision		Revision as of 15:45, 1 August 2009
Line 1:		Line 1:
−	~~'''''wip'''''~~
−
	__FORCETOC__		__FORCETOC__

AEXECUTE - Revision history

RanXerox: added categories

MrSugarCube at 15:45, 1 August 2009

MrSugarCube: Created page with ''''''wip''''' __FORCETOC__ ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to comple...'

MrSugarCube: Created page with ''''''wip''''' FORCETOC ==Description== This function will queue up a query and run it asynchronously in a background thread (rather than the script waiting for it to comple...'