/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.reactivex.ext.jdbc;

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

An asynchronous client interface for interacting with a JDBC compliant database

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.
/** * An asynchronous client interface for interacting with a JDBC compliant database * * <p/> * NOTE: This class has been automatically generated from the {@link io.vertx.ext.jdbc.JDBCClient original} non RX-ified interface using Vert.x codegen. */
@io.vertx.lang.rx.RxGen(io.vertx.ext.jdbc.JDBCClient.class) public class JDBCClient extends io.vertx.reactivex.ext.sql.SQLClient { @Override public String toString() { return delegate.toString(); } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; JDBCClient that = (JDBCClient) o; return delegate.equals(that.delegate); } @Override public int hashCode() { return delegate.hashCode(); } public static final io.vertx.lang.rx.TypeArg<JDBCClient> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>( obj -> new JDBCClient((io.vertx.ext.jdbc.JDBCClient) obj), JDBCClient::getDelegate ); private final io.vertx.ext.jdbc.JDBCClient delegate; public JDBCClient(io.vertx.ext.jdbc.JDBCClient delegate) { super(delegate); this.delegate = delegate; } public io.vertx.ext.jdbc.JDBCClient getDelegate() { return delegate; }
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.
Params:
  • sql – the statement to execute
  • handler – the result handler
Returns:self
/** * 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 * @param handler the result handler * @return self */
public io.vertx.reactivex.ext.sql.SQLOperations querySingle(String sql, Handler<AsyncResult<JsonArray>> handler) { delegate.querySingle(sql, handler); return this; }
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.
Params:
  • sql – the statement to execute
Returns:self
/** * 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 * @return self */
public Maybe<JsonArray> rxQuerySingle(String sql) { return io.vertx.reactivex.impl.AsyncResultMaybe.toMaybe(handler -> { querySingle(sql, handler); }); }
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.
Params:
  • sql – the statement to execute
  • arguments – the arguments
  • handler – the result handler
Returns:self
/** * 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 * @param arguments the arguments * @param handler the result handler * @return self */
public io.vertx.reactivex.ext.sql.SQLOperations querySingleWithParams(String sql, JsonArray arguments, Handler<AsyncResult<JsonArray>> handler) { delegate.querySingleWithParams(sql, arguments, handler); return this; }
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.
Params:
  • sql – the statement to execute
  • arguments – the arguments
Returns:self
/** * 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 * @param arguments the arguments * @return self */
public Maybe<JsonArray> rxQuerySingleWithParams(String sql, JsonArray arguments) { return io.vertx.reactivex.impl.AsyncResultMaybe.toMaybe(handler -> { querySingleWithParams(sql, arguments, handler); }); }
Create a JDBC client which maintains its own data source.
Params:
  • vertx – the Vert.x instance
  • config – the configuration
Returns:the client
/** * Create a JDBC client which maintains its own data source. * @param vertx the Vert.x instance * @param config the configuration * @return the client */
public static io.vertx.reactivex.ext.jdbc.JDBCClient createNonShared(io.vertx.reactivex.core.Vertx vertx, JsonObject config) { io.vertx.reactivex.ext.jdbc.JDBCClient ret = io.vertx.reactivex.ext.jdbc.JDBCClient.newInstance(io.vertx.ext.jdbc.JDBCClient.createNonShared(vertx.getDelegate(), config)); return ret; }
Create a JDBC client which shares its data source with any other JDBC clients created with the same data source name
Params:
  • vertx – the Vert.x instance
  • config – the configuration
  • dataSourceName – the data source name
Returns:the client
/** * Create a JDBC client which shares its data source with any other JDBC clients created with the same * data source name * @param vertx the Vert.x instance * @param config the configuration * @param dataSourceName the data source name * @return the client */
public static io.vertx.reactivex.ext.jdbc.JDBCClient createShared(io.vertx.reactivex.core.Vertx vertx, JsonObject config, String dataSourceName) { io.vertx.reactivex.ext.jdbc.JDBCClient ret = io.vertx.reactivex.ext.jdbc.JDBCClient.newInstance(io.vertx.ext.jdbc.JDBCClient.createShared(vertx.getDelegate(), config, dataSourceName)); return ret; }
Like createShared but with the default data source name
Params:
  • vertx – the Vert.x instance
  • config – the configuration
Returns:the client
/** * Like {@link io.vertx.reactivex.ext.jdbc.JDBCClient#createShared} but with the default data source name * @param vertx the Vert.x instance * @param config the configuration * @return the client */
public static io.vertx.reactivex.ext.jdbc.JDBCClient createShared(io.vertx.reactivex.core.Vertx vertx, JsonObject config) { io.vertx.reactivex.ext.jdbc.JDBCClient ret = io.vertx.reactivex.ext.jdbc.JDBCClient.newInstance(io.vertx.ext.jdbc.JDBCClient.createShared(vertx.getDelegate(), config)); return ret; }
The default data source provider is C3P0
/** * The default data source provider is C3P0 */
public static final String DEFAULT_PROVIDER_CLASS = io.vertx.ext.jdbc.JDBCClient.DEFAULT_PROVIDER_CLASS;
The name of the default data source
/** * The name of the default data source */
public static final String DEFAULT_DS_NAME = io.vertx.ext.jdbc.JDBCClient.DEFAULT_DS_NAME; public static JDBCClient newInstance(io.vertx.ext.jdbc.JDBCClient arg) { return arg != null ? new JDBCClient(arg) : null; } }