Difference between revisions of "ExecSQL"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(7 intermediate revisions by the same user not shown)
Line 12: Line 12:


====Returns====
====Returns====
:[[Result Class|<tt>Result</tt>]] object. If the return code is greater than zero, use the [[Result_Class#getIterator]] method to cycle through the list of [[Parameters class|Parameters]] objects it contains, one per record.
:[[Result Class|<tt>Result</tt>]] object. If the return code is greater than zero, use the [[Result_Class#getIterator]] method to cycle through the list of [[Parameters Class|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>


====Sample App====
====Sample App====

Latest revision as of 23:43, 2 May 2014

Execute a SQL query.

Syntax

Result result = Functions.execSQL(String query);

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:

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");        
}

Sample App

This sample uses the execSQL operation to populate a JSP page with a list of object records.

Learn More