io.vertx.sqlclient.impl

Class SqlClientBase<C extends SqlClient>

java.lang.Object

io.vertx.sqlclient.impl.SqlClientBase<C>

All Implemented Interfaces:

CommandScheduler, SqlClientInternal, SqlClient

Direct Known Subclasses:

JDBCPoolImpl, PoolBase, SqlConnectionBase

public abstract class SqlClientBase<C extends SqlClient>
extends Object
implements SqlClientInternal, CommandScheduler

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientMetrics	metrics
protected QueryTracer	tracer

Constructor Summary

Constructors

Constructor and Description
SqlClientBase(QueryTracer tracer, ClientMetrics metrics)

Method Summary

Modifier and Type	Method and Description
int	appendQueryPlaceholder(StringBuilder queryBuilder, int index, int current) Append a parameter placeholder in the query.
PreparedQuery<RowSet<Row>>	preparedQuery(String sql) Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.
protected abstract <T> PromiseInternal<T>	promise()
protected abstract <T> PromiseInternal<T>	promise(Handler<AsyncResult<T>> handler)
Query<RowSet<Row>>	query(String sql) Create a query, the Query.execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) method must be called to execute the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.sqlclient.SqlClient

close, close

Methods inherited from interface io.vertx.sqlclient.impl.command.CommandScheduler

schedule

Field Detail

tracer

protected final QueryTracer tracer

metrics

protected final ClientMetrics metrics

Constructor Detail

SqlClientBase

public SqlClientBase(QueryTracer tracer,
                     ClientMetrics metrics)

Method Detail

appendQueryPlaceholder

public int appendQueryPlaceholder(StringBuilder queryBuilder,
                                  int index,
                                  int current)

Description copied from interface: SqlClientInternal

Append a parameter placeholder in the query.

The index starts at 0.

• When index == current indicates it is a new parameter and therefore the same * value should be returned.
• When index < current indicates the builder wants to reuse a parameter. The implementation can either return the same value to indicate the parameter can be reused or return the next index to use (which is shall be the current value

Specified by:

appendQueryPlaceholder in interface SqlClientInternal

Parameters:

queryBuilder - the builder to append to

index - the parameter placeholder index

Returns:

the index at which the parameter placeholder could be added

promise

protected abstract <T> PromiseInternal<T> promise()

promise

protected abstract <T> PromiseInternal<T> promise(Handler<AsyncResult<T>> handler)

query

public Query<RowSet<Row>> query(String sql)

Description copied from interface: SqlClient

Create a query, the Query.execute(io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) method must be called to execute the query.

Specified by:

query in interface SqlClient

Returns:

the query

preparedQuery

public PreparedQuery<RowSet<Row>> preparedQuery(String sql)

Description copied from interface: SqlClient

Create a prepared query, one of the PreparedQuery.execute(io.vertx.sqlclient.Tuple, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) or PreparedQuery.executeBatch(java.util.List<io.vertx.sqlclient.Tuple>, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>) methods must be called to execute the query.

Specified by:

preparedQuery in interface SqlClient

Returns:

the prepared query