execSQL

From AgileApps Support Wiki
Revision as of 20:19, 1 May 2014 by imported>Aeric

Execute a SQL query.

Syntax

<syntaxhighlight lang="java" enclose="div">

Result result = Functions.execSQL(String query); </syntaxhighlight>

Parameters

query
The SQL query to execute.
Learn more: SQL Syntax

Returns

Result object. If the return code is greater than zero, use the Result_Class#getIterator method to cycle through the list of Parameters objects it contains, one per record.

Sample Code

This sample retrieves a value from the most recent record that matches the specified criteria:

<syntaxhighlight lang="java" enclose="div">

try {

  String latest_value;
  String sql = 
     "SELECT some_field FROM MyObject " +
     "WHERE another_field = '" + someValue + "' " +
     "ORDER BY date_created DESC " +            
     "LIMIT 1";
  Result result = Functions.execSQL(sql);
  int resultCode = result.getCode();
  if (resultCode < 0)
  {
     // Error occurred
     String msg = "Sample: Error during SQL search";
     Logger.info("Sample:\n" + result.getMessage(), "SQL");
  }
  else if (resultCode > 0)
  {
     // A record was found. (Otherwise, resultCode == 0)                     
     ParametersIterator it = result.getIterator();
     Parameters params = it.next();  // Use a loop if Limit > 1       
     latest_value = params.get("some_field");
     Logger.info("Sample: latest value = " + latest_value, "SQL");        
  }

} catch (Exception e) {

  String msg = "Sample: Exception during SQL search";
  Logger.info("Sample:\n" + e.getMessage(), "SQL");        

} </syntaxhighlight>

Learn More