vertx-lang-scala-docs_2.12 3.4.2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package sql
  Definition Classes
    ext
- ResultSet
- SQLClient
- SQLConnection
- SQLRowStream
- UpdateResult

c

io.vertx.scala.ext.sql

# SQLRowStream 

###
Companion object SQLRowStream

#### 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
     SQLRowStream → ReadStream → StreamBase
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @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.

   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.

    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.

    returns

      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.

    returns

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

    Definition Classes
      SQLRowStream → ReadStream
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.

    handler

      the exception handler

    returns

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

    Definition Classes
      SQLRowStream → ReadStream → StreamBase
16.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
17.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
18.  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.

    returns

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

    Definition Classes
      SQLRowStream → ReadStream
19.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
20.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
21.  def moreResults(): Unit

    Request for more results if available

22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
25.  def pause(): SQLRowStream

    Pause the `ReadSupport`.

    Pause the `ReadSupport`. While it's paused, no data will be sent to the `dataHandler`

    returns

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

    Definition Classes
      SQLRowStream → ReadStream
26.  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.

    handler

      called when the current result set is closed

27.  def resume(): SQLRowStream

    Resume reading.

    Resume reading. If the `ReadSupport` has been paused, reading will recommence on it.

    returns

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

    Definition Classes
      SQLRowStream → ReadStream
28.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
29.  def toString(): String
    Definition Classes
      AnyRef → Any
30.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
31.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
32.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from ReadStream[JsonArray]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped