vertx / io.vertx.ext.sql / SQLRowStream

# SQLRowStream

`interface SQLRowStream : ReadStream<JsonArray>`

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.

### Functions

close | `abstract fun close(): Unit` `abstract fun close(handler: Handler<AsyncResult<Void>>): Unit` Closes the stream/underlying cursor(s). The actual close happens asynchronously.
column | `abstract fun column(name: String): Int` Will convert the column name to the json array index.
columns | `abstract fun columns(): MutableList<String>` 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.
endHandler | `abstract fun endHandler(endHandler: Handler<Void>): SQLRowStream`
exceptionHandler | `abstract fun exceptionHandler(handler: Handler<Throwable>): SQLRowStream`
handler | `abstract fun handler(handler: Handler<JsonArray>): SQLRowStream`
moreResults | `abstract fun moreResults(): Unit` Request for more results if available
pause | `abstract fun pause(): SQLRowStream`
resultSetClosedHandler | `abstract fun resultSetClosedHandler(handler: Handler<Void>): SQLRowStream` Event handler when a resultset is closed. This is useful to request for more results.
resume | `abstract fun resume(): SQLRowStream`