SQL | JMP 12

Returns the SQL that the query generates when you run it.

obj<<Run(<private>, <UpdateTable(table)>, <OnRunComplete(script)>, <OnRunCanceled(script)>, <OnError(script)>

Runs the SQL query in the background or foreground depending on the Query Builder preference “Run queries in the background when possible”.

Returns

Null (if the query runs in the background) or a data table (if the query runs in the foreground).

Arguments

private

Optional. Opens the data table that the query produces without displaying it in a data table window.

UpdateTable

Optional. Updates the specified data table. Runs the query in the foreground.

OnRunComplete

Optional. Specifies a script to run after the query is complete.

OnRunCanceled

Optional. Specifies a script to run after the user cancels the query.

OnError

Optional. Specifies a script to run if an error occurs.

Notes

If you want the data table that results from the background query, use the OnRunComplete optional argument. You can include a script that runs when the query completes and then assigns a data table reference to the resulting data table. Or you might pass the name of a function that accepts a data table as its first argument. That function is called when the query completes.

Examples

The following example opens a query that you previously saved from Query Builder. The query opens privately, that is, without opening Query Builder. The query runs, and the resulting data table opens.

query = Open( "c:/My Data/Movies.jmpquery", private);

dt = query << Run();

You can include a .jmpquery file in a script and run the query in the background using the <<Run Background message.

query = Include( "C:\Queries\movies.jmpquery");

query <<Run Background();

The following example queries the database, opens the resulting data table, and prints the number of data table rows to the log.

confirmation = Function( {dtResult},

Write( "\!NNumber of rows in query result: ", N Rows( dtResult ) )

);

query = New SQL Query(