/*
* 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.mysqlclient;
import io.vertx.reactivex.RxHelper;
import io.vertx.reactivex.ObservableHelper;
import io.vertx.reactivex.FlowableHelper;
import io.vertx.reactivex.impl.AsyncResultMaybe;
import io.vertx.reactivex.impl.AsyncResultSingle;
import io.vertx.reactivex.impl.AsyncResultCompletable;
import io.vertx.reactivex.WriteStreamObserver;
import io.vertx.reactivex.WriteStreamSubscriber;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;
An interface which represents a connection to MySQL server.
The connection object supports all the operations defined in the interface,
in addition it provides MySQL utility command support:
- COM_PING
- COM_CHANGE_USER
- COM_RESET_CONNECTION
- COM_DEBUG
- COM_INIT_DB
- COM_STATISTICS
- COM_SET_OPTION
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen. /**
* An interface which represents a connection to MySQL server.
* <P>
* The connection object supports all the operations defined in the interface,
* in addition it provides MySQL utility command support:
* <ul>
* <li>COM_PING</li>
* <li>COM_CHANGE_USER</li>
* <li>COM_RESET_CONNECTION</li>
* <li>COM_DEBUG</li>
* <li>COM_INIT_DB</li>
* <li>COM_STATISTICS</li>
* <li>COM_SET_OPTION</li>
* </ul>
* </P>
*
* <p/>
* NOTE: This class has been automatically generated from the {@link io.vertx.mysqlclient.MySQLConnection original} non RX-ified interface using Vert.x codegen.
*/
@RxGen(io.vertx.mysqlclient.MySQLConnection.class)
public class MySQLConnection extends io.vertx.reactivex.sqlclient.SqlConnection {
@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;
MySQLConnection that = (MySQLConnection) o;
return delegate.equals(that.delegate);
}
@Override
public int hashCode() {
return delegate.hashCode();
}
public static final TypeArg<MySQLConnection> __TYPE_ARG = new TypeArg<>( obj -> new MySQLConnection((io.vertx.mysqlclient.MySQLConnection) obj),
MySQLConnection::getDelegate
);
private final io.vertx.mysqlclient.MySQLConnection delegate;
public MySQLConnection(io.vertx.mysqlclient.MySQLConnection delegate) {
super(delegate);
this.delegate = delegate;
}
public MySQLConnection(Object delegate) {
super((io.vertx.mysqlclient.MySQLConnection)delegate);
this.delegate = (io.vertx.mysqlclient.MySQLConnection)delegate;
}
public io.vertx.mysqlclient.MySQLConnection getDelegate() {
return delegate;
}
Create a connection to MySQL server with the given connectOptions
.
Params: - vertx – the vertx instance
- connectOptions – the options for the connection
- handler – the handler called with the connection or the failure
/**
* Create a connection to MySQL server with the given <code>connectOptions</code>.
* @param vertx the vertx instance
* @param connectOptions the options for the connection
* @param handler the handler called with the connection or the failure
*/
public static void connect(io.vertx.reactivex.core.Vertx vertx, io.vertx.mysqlclient.MySQLConnectOptions connectOptions, Handler<AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>> handler) {
io.vertx.mysqlclient.MySQLConnection.connect(vertx.getDelegate(), connectOptions, new Handler<AsyncResult<io.vertx.mysqlclient.MySQLConnection>>() {
public void handle(AsyncResult<io.vertx.mysqlclient.MySQLConnection> ar) {
if (ar.succeeded()) {
handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.mysqlclient.MySQLConnection.newInstance((io.vertx.mysqlclient.MySQLConnection)ar.result())));
} else {
handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
});
}
Create a connection to MySQL server with the given connectOptions
.
Params: - vertx – the vertx instance
- connectOptions – the options for the connection
/**
* Create a connection to MySQL server with the given <code>connectOptions</code>.
* @param vertx the vertx instance
* @param connectOptions the options for the connection
*/
public static void connect(io.vertx.reactivex.core.Vertx vertx, io.vertx.mysqlclient.MySQLConnectOptions connectOptions) {
connect(vertx, connectOptions, ar -> { });
}
Create a connection to MySQL server with the given connectOptions
.
Params: - vertx – the vertx instance
- connectOptions – the options for the connection
Returns:
/**
* Create a connection to MySQL server with the given <code>connectOptions</code>.
* @param vertx the vertx instance
* @param connectOptions the options for the connection
* @return
*/
public static io.reactivex.Single<io.vertx.reactivex.mysqlclient.MySQLConnection> rxConnect(io.vertx.reactivex.core.Vertx vertx, io.vertx.mysqlclient.MySQLConnectOptions connectOptions) {
return AsyncResultSingle.toSingle($handler -> {
connect(vertx, connectOptions, $handler);
});
}
Like connect
with options build from connectionUri
.
Params: - vertx –
- connectionUri –
- handler –
/**
* Like {@link io.vertx.reactivex.mysqlclient.MySQLConnection#connect} with options build from <code>connectionUri</code>.
* @param vertx
* @param connectionUri
* @param handler
*/
public static void connect(io.vertx.reactivex.core.Vertx vertx, String connectionUri, Handler<AsyncResult<io.vertx.reactivex.mysqlclient.MySQLConnection>> handler) {
io.vertx.mysqlclient.MySQLConnection.connect(vertx.getDelegate(), connectionUri, new Handler<AsyncResult<io.vertx.mysqlclient.MySQLConnection>>() {
public void handle(AsyncResult<io.vertx.mysqlclient.MySQLConnection> ar) {
if (ar.succeeded()) {
handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.mysqlclient.MySQLConnection.newInstance((io.vertx.mysqlclient.MySQLConnection)ar.result())));
} else {
handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
});
}
Like connect
with options build from connectionUri
.
Params: - vertx –
- connectionUri –
/**
* Like {@link io.vertx.reactivex.mysqlclient.MySQLConnection#connect} with options build from <code>connectionUri</code>.
* @param vertx
* @param connectionUri
*/
public static void connect(io.vertx.reactivex.core.Vertx vertx, String connectionUri) {
connect(vertx, connectionUri, ar -> { });
}
Like connect
with options build from connectionUri
.
Params: - vertx –
- connectionUri –
Returns:
/**
* Like {@link io.vertx.reactivex.mysqlclient.MySQLConnection#connect} with options build from <code>connectionUri</code>.
* @param vertx
* @param connectionUri
* @return
*/
public static io.reactivex.Single<io.vertx.reactivex.mysqlclient.MySQLConnection> rxConnect(io.vertx.reactivex.core.Vertx vertx, String connectionUri) {
return AsyncResultSingle.toSingle($handler -> {
connect(vertx, connectionUri, $handler);
});
}
Params: - sql –
- handler –
Returns:
/**
*
* @param sql
* @param handler
* @return
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection prepare(String sql, Handler<AsyncResult<io.vertx.reactivex.sqlclient.PreparedStatement>> handler) {
delegate.prepare(sql, new Handler<AsyncResult<io.vertx.sqlclient.PreparedStatement>>() {
public void handle(AsyncResult<io.vertx.sqlclient.PreparedStatement> ar) {
if (ar.succeeded()) {
handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.sqlclient.PreparedStatement.newInstance((io.vertx.sqlclient.PreparedStatement)ar.result())));
} else {
handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
}
}
});
return this;
}
Params: - sql –
Returns:
/**
*
* @param sql
* @return
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection prepare(String sql) {
return
prepare(sql, ar -> { });
}
Params: - sql –
Returns:
/**
*
* @param sql
* @return
*/
public io.reactivex.Single<io.vertx.reactivex.sqlclient.PreparedStatement> rxPrepare(String sql) {
return AsyncResultSingle.toSingle($handler -> {
prepare(sql, $handler);
});
}
Params: - handler –
Returns:
/**
*
* @param handler
* @return
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection exceptionHandler(Handler<java.lang.Throwable> handler) {
delegate.exceptionHandler(handler);
return this;
}
Params: - handler –
Returns:
/**
*
* @param handler
* @return
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection closeHandler(Handler<Void> handler) {
delegate.closeHandler(handler);
return this;
}
Send a PING command to check if the server is alive.
Params: - handler – the handler notified when the server responses to client
Returns: a reference to this, so the API can be used fluently
/**
* Send a PING command to check if the server is alive.
* @param handler the handler notified when the server responses to client
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection ping(Handler<AsyncResult<Void>> handler) {
delegate.ping(handler);
return this;
}
Send a PING command to check if the server is alive.
Returns: a reference to this, so the API can be used fluently
/**
* Send a PING command to check if the server is alive.
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection ping() {
return
ping(ar -> { });
}
Send a PING command to check if the server is alive.
Returns: a reference to this, so the API can be used fluently
/**
* Send a PING command to check if the server is alive.
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxPing() {
return AsyncResultCompletable.toCompletable($handler -> {
ping($handler);
});
}
Send a INIT_DB command to change the default schema of the connection.
Params: - schemaName – name of the schema to change to
- handler – the handler notified with the execution result
Returns: a reference to this, so the API can be used fluently
/**
* Send a INIT_DB command to change the default schema of the connection.
* @param schemaName name of the schema to change to
* @param handler the handler notified with the execution result
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection specifySchema(String schemaName, Handler<AsyncResult<Void>> handler) {
delegate.specifySchema(schemaName, handler);
return this;
}
Send a INIT_DB command to change the default schema of the connection.
Params: - schemaName – name of the schema to change to
Returns: a reference to this, so the API can be used fluently
/**
* Send a INIT_DB command to change the default schema of the connection.
* @param schemaName name of the schema to change to
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection specifySchema(String schemaName) {
return
specifySchema(schemaName, ar -> { });
}
Send a INIT_DB command to change the default schema of the connection.
Params: - schemaName – name of the schema to change to
Returns: a reference to this, so the API can be used fluently
/**
* Send a INIT_DB command to change the default schema of the connection.
* @param schemaName name of the schema to change to
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxSpecifySchema(String schemaName) {
return AsyncResultCompletable.toCompletable($handler -> {
specifySchema(schemaName, $handler);
});
}
Send a STATISTICS command to get a human readable string of the server internal status.
Params: - handler – the handler notified with the execution result
Returns: a reference to this, so the API can be used fluently
/**
* Send a STATISTICS command to get a human readable string of the server internal status.
* @param handler the handler notified with the execution result
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection getInternalStatistics(Handler<AsyncResult<String>> handler) {
delegate.getInternalStatistics(handler);
return this;
}
Send a STATISTICS command to get a human readable string of the server internal status.
Returns: a reference to this, so the API can be used fluently
/**
* Send a STATISTICS command to get a human readable string of the server internal status.
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection getInternalStatistics() {
return
getInternalStatistics(ar -> { });
}
Send a STATISTICS command to get a human readable string of the server internal status.
Returns: a reference to this, so the API can be used fluently
/**
* Send a STATISTICS command to get a human readable string of the server internal status.
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Single<String> rxGetInternalStatistics() {
return AsyncResultSingle.toSingle($handler -> {
getInternalStatistics($handler);
});
}
Send a SET_OPTION command to set options for the current connection.
Params: - option – the options to set
- handler – the handler notified with the execution result
Returns: a reference to this, so the API can be used fluently
/**
* Send a SET_OPTION command to set options for the current connection.
* @param option the options to set
* @param handler the handler notified with the execution result
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection setOption(io.vertx.mysqlclient.MySQLSetOption option, Handler<AsyncResult<Void>> handler) {
delegate.setOption(option, handler);
return this;
}
Send a SET_OPTION command to set options for the current connection.
Params: - option – the options to set
Returns: a reference to this, so the API can be used fluently
/**
* Send a SET_OPTION command to set options for the current connection.
* @param option the options to set
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection setOption(io.vertx.mysqlclient.MySQLSetOption option) {
return
setOption(option, ar -> { });
}
Send a SET_OPTION command to set options for the current connection.
Params: - option – the options to set
Returns: a reference to this, so the API can be used fluently
/**
* Send a SET_OPTION command to set options for the current connection.
* @param option the options to set
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxSetOption(io.vertx.mysqlclient.MySQLSetOption option) {
return AsyncResultCompletable.toCompletable($handler -> {
setOption(option, $handler);
});
}
Send a RESET_CONNECTION command to reset the session state.
Params: - handler – the handler notified with the execution result
Returns: a reference to this, so the API can be used fluently
/**
* Send a RESET_CONNECTION command to reset the session state.
* @param handler the handler notified with the execution result
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection resetConnection(Handler<AsyncResult<Void>> handler) {
delegate.resetConnection(handler);
return this;
}
Send a RESET_CONNECTION command to reset the session state.
Returns: a reference to this, so the API can be used fluently
/**
* Send a RESET_CONNECTION command to reset the session state.
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection resetConnection() {
return
resetConnection(ar -> { });
}
Send a RESET_CONNECTION command to reset the session state.
Returns: a reference to this, so the API can be used fluently
/**
* Send a RESET_CONNECTION command to reset the session state.
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxResetConnection() {
return AsyncResultCompletable.toCompletable($handler -> {
resetConnection($handler);
});
}
Send a DEBUG command to dump debug information to the server's stdout.
Params: - handler – the handler notified with the execution result
Returns: a reference to this, so the API can be used fluently
/**
* Send a DEBUG command to dump debug information to the server's stdout.
* @param handler the handler notified with the execution result
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection debug(Handler<AsyncResult<Void>> handler) {
delegate.debug(handler);
return this;
}
Send a DEBUG command to dump debug information to the server's stdout.
Returns: a reference to this, so the API can be used fluently
/**
* Send a DEBUG command to dump debug information to the server's stdout.
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection debug() {
return
debug(ar -> { });
}
Send a DEBUG command to dump debug information to the server's stdout.
Returns: a reference to this, so the API can be used fluently
/**
* Send a DEBUG command to dump debug information to the server's stdout.
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxDebug() {
return AsyncResultCompletable.toCompletable($handler -> {
debug($handler);
});
}
Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
Params: - options – authentication options
- handler – the handler
Returns: a reference to this, so the API can be used fluently
/**
* Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
* @param options authentication options
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection changeUser(io.vertx.mysqlclient.MySQLAuthOptions options, Handler<AsyncResult<Void>> handler) {
delegate.changeUser(options, handler);
return this;
}
Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
Params: - options – authentication options
Returns: a reference to this, so the API can be used fluently
/**
* Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
* @param options authentication options
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.reactivex.mysqlclient.MySQLConnection changeUser(io.vertx.mysqlclient.MySQLAuthOptions options) {
return
changeUser(options, ar -> { });
}
Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
Params: - options – authentication options
Returns: a reference to this, so the API can be used fluently
/**
* Send a CHANGE_USER command to change the user of the current connection, this operation will also reset connection state.
* @param options authentication options
* @return a reference to this, so the API can be used fluently
*/
public io.reactivex.Completable rxChangeUser(io.vertx.mysqlclient.MySQLAuthOptions options) {
return AsyncResultCompletable.toCompletable($handler -> {
changeUser(options, $handler);
});
}
public static MySQLConnection newInstance(io.vertx.mysqlclient.MySQLConnection arg) {
return arg != null ? new MySQLConnection(arg) : null;
}
}