GPUdbSqlIterator

java.lang.Object

com.gpudb.GPUdbSqlIterator<T>

All Implemented Interfaces:

AutoCloseable, Iterable<T>

public class GPUdbSqlIterator<T extends Record> extends Object implements Iterable<T>, AutoCloseable

Kinetica API class for iterating over records returned by executing an SQL query. This class accepts a GPUdb instance and an SQL statement to facilitate iteration over the records returned by the query. SQL options can be passed as a Map. The ‘batchSize’ for the number of records returned is set to a default of ‘10000’, which can be modified using the parameter ‘batchSize’ to the constructor. Example usage, passing a database connection and a SQL statement to the GPUdbSqlIterator:

 
     try (GPUdbSqlIterator<Record> iterator = new GPUdbSqlIterator<>(gpudb, sql);)
     {
         for (Record record : iterator)
             System.out.println(record);
     }
     catch (Exception e)
     {
         System.err.println("Error in iteration: " + e.getMessage());
     }
 

Constructor Summary
Constructors
Constructor
Description
GPUdbSqlIterator(GPUdb db, String sql)
Constructor for GPUdbSqlIterator
GPUdbSqlIterator(GPUdb db, String sql, int batchSize)
Constructor for GPUdbSqlIterator
GPUdbSqlIterator(GPUdb db, String sql, int batchSize, Map<String,String> sqlOptions)
Constructor for GPUdbSqlIterator
GPUdbSqlIterator(GPUdb db, String sql, Map<String,String> sqlOptions)
Constructor for GPUdbSqlIterator
Method Summary
Modifier and Type
Method
Description
void
close()

Iterator<T>
iterator()

void
setSqlOptions(Map<String,String> sqlOptions)

long
size()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Constructor Details
- GPUdbSqlIterator
  public GPUdbSqlIterator(GPUdb db, String sql) throws GPUdbException
  Constructor for GPUdbSqlIterator
  Parameters:
  db - - a GPUdb instance
  sql - - the SQL statement to execute
  Throws:
  GPUdbException
- GPUdbSqlIterator
  public GPUdbSqlIterator(GPUdb db, String sql, int batchSize) throws GPUdbException
  Constructor for GPUdbSqlIterator
  Parameters:
  db - - a GPUdb instance
  sql - - the SQL statement to execute
  batchSize - - the number of records to fetch
  Throws:
  GPUdbException
- GPUdbSqlIterator
  public GPUdbSqlIterator(GPUdb db, String sql, Map<String,String> sqlOptions) throws GPUdbException
  Constructor for GPUdbSqlIterator
  Parameters:
  db - - a GPUdb instance
  sql - - the SQL statement to execute
  sqlOptions - - the SQL options to be passed in
  Throws:
  GPUdbException
  See Also:
  GPUdb.executeSql(String, long, long, String, List, Map)
- GPUdbSqlIterator
  public GPUdbSqlIterator(GPUdb db, String sql, int batchSize, Map<String,String> sqlOptions) throws GPUdbException
  Constructor for GPUdbSqlIterator
  Parameters:
  db - - a GPUdb instance
  sql - - the SQL statement to execute
  batchSize - - the number of records to fetch
  sqlOptions - - the SQL options to be passed in
  Throws:
  GPUdbException
  See Also:
  GPUdb.executeSql(String, long, long, String, List, Map)
Method Details
- setSqlOptions
  public void setSqlOptions(Map<String,String> sqlOptions)
- size
  public long size()
- close
  public void close() throws Exception
  Specified by:
  close in interface AutoCloseable
  Throws:
  Exception
- iterator
  public Iterator<T> iterator()
  Specified by:
  iterator in interface Iterable<T extends Record>

​Class GPUdbSqlIterator<T extends Record>

​Constructor Summary

​Method Summary

​Methods inherited from class java.lang.Object

​Methods inherited from interface java.lang.Iterable

​Constructor Details