vertx-lang-scala-docs_2.12 3.8.0 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
- SQLOperations
- SQLOptions
- SQLRowStream
- UpdateResult

t

io.vertx.scala.ext.sql

# SQLOperations 

###
Companion object SQLOperations

#### trait SQLOperations extends AnyRef

Represents a SQL query interface to a database

Linear Supertypes
AnyRef, Any
Known Subclasses
AsyncSQLClient, MySQLClient, PostgreSQLClient, JDBCClient, SQLClient, SQLConnection
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. SQLOperations
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def asJava: AnyRef
2.  abstract def call(sql: String, resultHandler: Handler[AsyncResult[ResultSet]]): SQLOperations

   Calls the given SQL `PROCEDURE` which returns the result from the procedure.

   Calls the given SQL `PROCEDURE` which returns the result from the procedure. * @param sql the SQL to execute. For example `{call getEmpName``.

   resultHandler

     the handler which is called once the operation completes. It will return a `ResultSet`.

3.  abstract def callFuture(sql: String): Future[ResultSet]

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

4.  abstract def callWithParams(sql: String, params: JsonArray, outputs: JsonArray, resultHandler: Handler[AsyncResult[ResultSet]]): SQLOperations

   Calls the given SQL `PROCEDURE` which returns the result from the procedure.

   Calls the given SQL `PROCEDURE` which returns the result from the procedure.

   The index of params and outputs are important for both arrays, for example when dealing with a prodecure that takes the first 2 arguments as input values and the 3 arg as an output then the arrays should be like:

         params = [VALUE1, VALUE2, null]
         outputs = [null, null, "VARCHAR"]

   * @param sql the SQL to execute. For example `{call getEmpName (?, ?)``.
   params

     these are the parameters to fill the statement.

   outputs

     these are the outputs to fill the statement.

   resultHandler

     the handler which is called once the operation completes. It will return a `ResultSet`.

5.  abstract def callWithParamsFuture(sql: String, params: JsonArray, outputs: JsonArray): Future[ResultSet]

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

6.  abstract def query(sql: String, resultHandler: Handler[AsyncResult[ResultSet]]): SQLOperations

   Executes the given SQL `SELECT` statement which returns the results of the query.

   Executes the given SQL `SELECT` statement which returns the results of the query. * @param sql the SQL to execute. For example `SELECT * FROM table ...`.

   resultHandler

     the handler which is called once the operation completes. It will return a `ResultSet`.

7.  abstract def queryFuture(sql: String): Future[ResultSet]

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

8.  abstract def querySingle(sql: String, handler: Handler[AsyncResult[Option[JsonArray]]]): SQLOperations

   Execute a one shot SQL statement that returns a single SQL row.

   Execute a one shot SQL statement that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned. * @param sql the statement to execute

   handler

     the result handler

   returns

     self

9.  abstract def querySingleFuture(sql: String): Future[Option[JsonArray]]

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

10.  abstract def querySingleWithParams(sql: String, arguments: JsonArray, handler: Handler[AsyncResult[Option[JsonArray]]]): SQLOperations

    Execute a one shot SQL statement with arguments that returns a single SQL row.

    Execute a one shot SQL statement with arguments that returns a single SQL row. This method will reduce the boilerplate code by getting a connection from the pool (this object) and return it back after the execution. Only the first result from the result set is returned. * @param sql the statement to execute

    arguments

      the arguments

    handler

      the result handler

    returns

      self

11.  abstract def querySingleWithParamsFuture(sql: String, arguments: JsonArray): Future[Option[JsonArray]]

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

12.  abstract def queryStream(sql: String, handler: Handler[AsyncResult[SQLRowStream]]): SQLOperations

    Executes the given SQL `SELECT` statement which returns the results of the query as a read stream.

    Executes the given SQL `SELECT` statement which returns the results of the query as a read stream. * @param sql the SQL to execute. For example `SELECT * FROM table ...`.

    handler

      the handler which is called once the operation completes. It will return a `SQLRowStream`.

13.  abstract def queryStreamFuture(sql: String): Future[SQLRowStream]

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

14.  abstract def queryStreamWithParams(sql: String, params: JsonArray, handler: Handler[AsyncResult[SQLRowStream]]): SQLOperations

    Executes the given SQL `SELECT` statement which returns the results of the query as a read stream.

    Executes the given SQL `SELECT` statement which returns the results of the query as a read stream. * @param sql the SQL to execute. For example `SELECT * FROM table ...`.

    params

      these are the parameters to fill the statement.

    handler

      the handler which is called once the operation completes. It will return a `SQLRowStream`.

15.  abstract def queryStreamWithParamsFuture(sql: String, params: JsonArray): Future[SQLRowStream]

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

16.  abstract def queryWithParams(sql: String, params: JsonArray, resultHandler: Handler[AsyncResult[ResultSet]]): SQLOperations

    Executes the given SQL `SELECT` prepared statement which returns the results of the query.

    Executes the given SQL `SELECT` prepared statement which returns the results of the query. * @param sql the SQL to execute. For example `SELECT * FROM table ...`.

    params

      these are the parameters to fill the statement.

    resultHandler

      the handler which is called once the operation completes. It will return a `ResultSet`.

17.  abstract def queryWithParamsFuture(sql: String, params: JsonArray): Future[ResultSet]

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

18.  abstract def update(sql: String, resultHandler: Handler[AsyncResult[UpdateResult]]): SQLOperations

    Executes the given SQL statement which may be an `INSERT`, `UPDATE`, or `DELETE` statement.

    Executes the given SQL statement which may be an `INSERT`, `UPDATE`, or `DELETE` statement. * @param sql the SQL to execute. For example `INSERT INTO table ...`

    resultHandler

      the handler which is called once the operation completes.

19.  abstract def updateFuture(sql: String): Future[UpdateResult]

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

20.  abstract def updateWithParams(sql: String, params: JsonArray, resultHandler: Handler[AsyncResult[UpdateResult]]): SQLOperations

    Executes the given prepared statement which may be an `INSERT`, `UPDATE`, or `DELETE` statement with the given parameters * @param sql the SQL to execute.

    Executes the given prepared statement which may be an `INSERT`, `UPDATE`, or `DELETE` statement with the given parameters * @param sql the SQL to execute. For example `INSERT INTO table ...`

    params

      these are the parameters to fill the statement.

    resultHandler

      the handler which is called once the operation completes.

21.  abstract def updateWithParamsFuture(sql: String, params: JsonArray): Future[UpdateResult]

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

### Concrete 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 clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
9.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
19.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped