io.vertx.ext.sql.SQLRowStream Maven / Gradle / Ivy

Go to download
package io.vertx.ext.sql;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.json.JsonArray;
import io.vertx.core.streams.ReadStream;

import java.util.List;

/**
 * A ReadStream of Rows from the underlying RDBMS. This class follows the ReadStream semantics and will automatically
 * close the underlying resources if all returned rows are returned. For cases where the results are ignored before the
 * full processing of the returned rows is complete the close method **MUST** be called in order to release underlying
 * resources.
 *
 * The interface is minimal in order to support all SQL clients not just JDBC.
 */
@VertxGen
public interface SQLRowStream extends ReadStream {

  @Override
  SQLRowStream exceptionHandler(Handler handler);

  @Override
  SQLRowStream handler(Handler handler);

  @Override
  SQLRowStream pause();

  @Override
  SQLRowStream resume();

  @Override
  SQLRowStream endHandler(Handler endHandler);

  /**
   * Will convert the column name to the json array index.
   *
   * @param name the column name
   * @return the json array index
   */
  int column(String name);

  /**
   * Returns all column names available in the underlying resultset. One needs to carefully use this method since in
   * contrast to the singular version it does not perform case insensitive lookups or takes alias in consideration on
   * the column names.
   *
   * @return the list of columns names returned by the query
   */
  List columns();

  /**
   * Event handler when a resultset is closed. This is useful to request for more results.
   *
   * @param handler called when the current result set is closed
   */
  @Fluent
  SQLRowStream resultSetClosedHandler(Handler handler);

  /**
   * Request for more results if available
   */
  void moreResults();

  /**
   * Closes the stream/underlying cursor(s). The actual close happens asynchronously.
   */
  void close();

  /**
   * Closes the stream/underlying cursor(s). The actual close happens asynchronously.
   *
   * @param handler called when the stream/underlying cursor(s) is(are) closed
   */
  void close(Handler> handler);
}