io.vertx.sqlclient.SqlConnection Maven / Gradle / Ivy
/*
* Copyright (C) 2017 Julien Viet
*
* Licensed 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.sqlclient;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.sqlclient.spi.DatabaseMetadata;
/**
* A connection to the database server.
*
* @author Julien Viet
* @author Emad Alblueshi
*/
@VertxGen
public interface SqlConnection extends SqlClient {
/**
* Create a prepared statement using the given {@code sql} string.
*
* @param sql the sql
* @param handler the handler notified with the prepared query asynchronously
*/
@Fluent
SqlConnection prepare(String sql, Handler> handler);
/**
* Like {@link #prepare(String, Handler)} but returns a {@code Future} of the asynchronous result
*/
Future prepare(String sql);
/**
* Create a prepared statement using the given {@code sql} string.
*
* @param sql the sql
* @param handler the handler notified with the prepared query asynchronously
*/
@Fluent
SqlConnection prepare(String sql, PrepareOptions options, Handler> handler);
/**
* Like {@link #prepare(String, Handler)} but returns a {@code Future} of the asynchronous result
*/
Future prepare(String sql, PrepareOptions options);
/**
* Set an handler called with connection errors.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
SqlConnection exceptionHandler(Handler handler);
/**
* Set an handler called when the connection is closed.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
SqlConnection closeHandler(Handler handler);
/**
* Begin a transaction and returns a {@link Transaction} for controlling and tracking
* this transaction.
*
* When the connection is explicitely closed, any inflight transaction is rollbacked.
*/
void begin(Handler> handler);
/**
* Like {@link #begin(Handler)} but returns a {@code Future} of the asynchronous result
*/
Future begin();
/**
* @return the current transaction if it exists, otherwise null
*/
Transaction transaction();
/**
* @return whether the connection uses SSL
*/
boolean isSSL();
/**
* Close the current connection after all the pending commands have been processed.
*
* @param handler the completion handler
*/
void close(Handler> handler);
/**
* @return The static metadata about the backend database server for this connection
*/
DatabaseMetadata databaseMetadata();
}