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 jdbc
  Definition Classes
    ext
- JDBCClient

c

io.vertx.scala.ext.jdbc

# JDBCClient 

###
Companion object JDBCClient

#### class JDBCClient extends SQLClient

An asynchronous client interface for interacting with a JDBC compliant database

Linear Supertypes
SQLClient, SQLOperations, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. JDBCClient
2. SQLClient
3. SQLOperations
4. AnyRef
5. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new JDBCClient(_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
     SQLClient → SQLOperations
6.  def call(sql: String, handler: Handler[AsyncResult[ResultSet]]): SQLClient

   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``.

   handler

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

   Definition Classes
     SQLClient → SQLOperations
7.  def callFuture(sql: String): Future[ResultSet]

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

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

   Definition Classes
     SQLClient → SQLOperations
8.  def callWithParams(sql: String, params: JsonArray, outputs: JsonArray, handler: Handler[AsyncResult[ResultSet]]): SQLClient

   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.

   handler

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

   Definition Classes
     SQLClient → SQLOperations
9.  def callWithParamsFuture(sql: String, params: JsonArray, outputs: JsonArray): Future[ResultSet]

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

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

   Definition Classes
     SQLClient → SQLOperations
10.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
11.  def close(): Unit

    Close the client

    Close the client

    Definition Classes
      SQLClient
12.  def close(handler: Handler[AsyncResult[Unit]]): Unit

    Close the client and release all resources.

    Close the client and release all resources. Call the handler when close is complete. * @param handler the handler that will be called when close is complete

    Definition Classes
      SQLClient
13.  def closeFuture(): Future[Unit]

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

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

    Definition Classes
      SQLClient
14.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
15.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
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
    Annotations
      @native()
18.  def getConnection(handler: Handler[AsyncResult[SQLConnection]]): SQLClient

    Returns a connection that can be used to perform SQL operations on.

    Returns a connection that can be used to perform SQL operations on. It's important to remember to close the connection when you are done, so it is returned to the pool. * @param handler the handler which is called when the `JdbcConnection` object is ready for use.

    Definition Classes
      SQLClient
19.  def getConnectionFuture(): Future[SQLConnection]

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

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

    Definition Classes
      SQLClient
20.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
25.  def query(sql: String, handler: Handler[AsyncResult[ResultSet]]): SQLClient

    Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL statement and returns it back after the execution.

    Execute a single SQL statement, this method acquires a connection from the the pool and executes the SQL statement and returns it back after the execution. * @param sql the statement to execute

    handler

      the result handler

    returns

      self

    Definition Classes
      SQLClient → SQLOperations
26.  def queryFuture(sql: String): Future[ResultSet]

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

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

    Definition Classes
      SQLClient → SQLOperations
27.  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

    Definition Classes
      JDBCClient → SQLClient → SQLOperations
28.  def querySingleFuture(sql: String): Future[Option[JsonArray]]

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

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

    Definition Classes
      JDBCClient → SQLClient → SQLOperations
29.  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

    Definition Classes
      JDBCClient → SQLClient → SQLOperations
30.  def querySingleWithParamsFuture(sql: String, arguments: JsonArray): Future[Option[JsonArray]]

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

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

    Definition Classes
      JDBCClient → SQLClient → SQLOperations
31.  def queryStream(sql: String, handler: Handler[AsyncResult[SQLRowStream]]): SQLClient

    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`.

    Definition Classes
      SQLClient → SQLOperations
32.  def queryStreamFuture(sql: String): Future[SQLRowStream]

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

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

    Definition Classes
      SQLClient → SQLOperations
33.  def queryStreamWithParams(sql: String, params: JsonArray, handler: Handler[AsyncResult[SQLRowStream]]): SQLClient

    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`.

    Definition Classes
      SQLClient → SQLOperations
34.  def queryStreamWithParamsFuture(sql: String, params: JsonArray): Future[SQLRowStream]

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

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

    Definition Classes
      SQLClient → SQLOperations
35.  def queryWithParams(sql: String, arguments: JsonArray, handler: Handler[AsyncResult[ResultSet]]): SQLClient

    Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL prepared statement and returns it back after the execution.

    Execute a single SQL prepared statement, this method acquires a connection from the the pool and executes the SQL prepared statement and returns it back after the execution. * @param sql the statement to execute

    arguments

      the arguments to the statement

    handler

      the result handler

    returns

      self

    Definition Classes
      SQLClient → SQLOperations
36.  def queryWithParamsFuture(sql: String, arguments: JsonArray): Future[ResultSet]

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

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

    Definition Classes
      SQLClient → SQLOperations
37.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
38.  def toString(): String
    Definition Classes
      AnyRef → Any
39.  def update(sql: String, handler: Handler[AsyncResult[UpdateResult]]): SQLClient

    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 ...`

    handler

      the handler which is called once the operation completes.

    Definition Classes
      SQLClient → SQLOperations
40.  def updateFuture(sql: String): Future[UpdateResult]

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

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

    Definition Classes
      SQLClient → SQLOperations
41.  def updateWithParams(sql: String, params: JsonArray, handler: Handler[AsyncResult[UpdateResult]]): SQLClient

    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.

    handler

      the handler which is called once the operation completes.

    Definition Classes
      SQLClient → SQLOperations
42.  def updateWithParamsFuture(sql: String, params: JsonArray): Future[UpdateResult]

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

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

    Definition Classes
      SQLClient → SQLOperations
43.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
44.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
45.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from SQLClient

### Inherited from SQLOperations

### Inherited from AnyRef

### Inherited from Any

### Ungrouped