Packages

class SQLRowStream extends 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.

Linear Supertypes
ReadStream[JsonArray], StreamBase, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SQLRowStream
  2. ReadStream
  3. StreamBase
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SQLRowStream(_asJava: AnyRef)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: AnyRef
    Definition Classes
    SQLRowStreamReadStreamStreamBase
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def close(handler: Handler[AsyncResult[Unit]]): Unit

    Closes the stream/underlying cursor(s).

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

  8. def close(): Unit

    Closes the stream/underlying cursor(s).

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

  9. def closeFuture(): Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  10. def column(name: String): Int

    Will convert the column name to the json array index.

    Will convert the column name to the json array index. * @param name the column name

    returns

    the json array index

  11. def columns(): Buffer[String]

    Returns all column names available in the underlying resultset.

    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

  12. def endHandler(endHandler: Handler[Unit]): SQLRowStream

    Set an end handler.

    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. * @return a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStream
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def exceptionHandler(handler: Handler[Throwable]): SQLRowStream

    Set an exception handler on the read stream.

    Set an exception handler on the read stream. * @param handler the exception handler

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStreamStreamBase
  16. def fetch(arg0: Long): ReadStream[JsonArray]

    Fetch the specified amount of elements.

    Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand. * @return a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStream
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def handler(handler: Handler[JsonArray]): SQLRowStream

    Set a data handler.

    Set a data handler. As data is read, the handler will be called with the data. * @return a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStream
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def moreResults(): Unit

    Request for more results if available

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def pause(): SQLRowStream

    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

    Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

    While it's paused, no data will be sent to the data handler. * @return a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStream
  27. def pipe(): Pipe[JsonArray]

    Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

    Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

    The stream will be resumed when the pipe will be wired to a WriteStream. * @return a pipe

    Definition Classes
    SQLRowStreamReadStream
  28. def pipeTo(dst: WriteStream[JsonArray], handler: Handler[AsyncResult[Unit]]): Unit

    Pipe this ReadStream to the WriteStream.

    Pipe this ReadStream to the WriteStream.

    Elements emitted by this stream will be written to the write stream until this stream ends or fails.

    Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result. * @param dst the destination write stream

    Definition Classes
    SQLRowStreamReadStream
  29. def pipeTo(dst: WriteStream[JsonArray]): Unit

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Definition Classes
    SQLRowStreamReadStream
  30. def pipeToFuture(dst: WriteStream[JsonArray]): Future[Unit]

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
    SQLRowStreamReadStream
  31. def resultSetClosedHandler(handler: Handler[Unit]): SQLRowStream

    Event handler when a resultset is closed.

    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

  32. def resume(): SQLRowStream

    Resume reading, and sets the buffer in flowing mode.

    Resume reading, and sets the buffer in flowing mode.

    If the ReadStream has been paused, reading will recommence on it. * @return a reference to this, so the API can be used fluently

    Definition Classes
    SQLRowStreamReadStream
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ReadStream[JsonArray]

Inherited from StreamBase

Inherited from AnyRef

Inherited from Any

Ungrouped