/*
 *  Copyright 2015 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.asyncsql;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Vertx;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.asyncsql.impl.ClientHelper;
import io.vertx.ext.sql.SQLClient;

import java.util.UUID;

Represents an asynchronous MySQL client
Author:
Joern Bernhardt., Tim Fox/**
 * Represents an asynchronous MySQL client
 *
 * @author <a href="http://www.campudus.com">Joern Bernhardt</a>.
 * @author <a href="http://tfox.org">Tim Fox</a>
 */
@VertxGen
public interface MySQLClient extends AsyncSQLClient {

  
The default name used for the MySQL pool.
/**
   * The default name used for the MySQL pool.
   */
  String DEFAULT_POOL_NAME = "DEFAULT_MYSQL_POOL";

  
The default host.
/**
   * The default host.
   */
  String DEFAULT_HOST = "localhost";

  
The default port.
/**
   * The default port.
   */
  int DEFAULT_PORT = 3306;

  
The default database.
/**
   * The default database.
   */
  String DEFAULT_DATABASE = "testdb";

  
The default database user.
/**
   * The default database user.
   */
  String DEFAULT_USER = "vertx";

  
The default database password.
/**
   * The default database password.
   */
  String DEFAULT_PASSWORD = "password";

  
The default charset.
/**
   * The default charset.
   */
  String DEFAULT_CHARSET = "UTF-8";

  
The default timeout for connect.
/**
   * The default timeout for connect.
   */
  long DEFAULT_CONNECT_TIMEOUT = 10000L;

  
The default timeout for tests.
/**
   * The default timeout for tests.
   */
  long DEFAULT_TEST_TIMEOUT = 10000L;


  
Create a MySQL client which maintains its own pool.
Params:
vertx –   the Vert.x instance
config –  the configuration
Returns:
the client/**
   * Create a MySQL client which maintains its own pool.
   *
   * @param vertx   the Vert.x instance
   * @param config  the configuration
   * @return the client
   */
  static AsyncSQLClient createNonShared(Vertx vertx, JsonObject config) {
    return ClientHelper.getOrCreate(vertx, config, UUID.randomUUID().toString(), true);
  }


  
Create a MySQL client which shares its data source with any other MySQL clients created with the same
data source name
Params:
vertx –    the Vert.x instance
config –   the configuration
poolName – the pool name
Returns:
the client/**
   * Create a MySQL client which shares its data source with any other MySQL clients created with the same
   * data source name
   *
   * @param vertx    the Vert.x instance
   * @param config   the configuration
   * @param poolName the pool name
   * @return the client
   */
  static AsyncSQLClient createShared(Vertx vertx, JsonObject config, String poolName) {
    return ClientHelper.getOrCreate(vertx, config, poolName, true);
  }


  
Like createShared(Vertx, JsonObject, String) but with the default pool name 
Params:
vertx –   the Vert.x instance
config –  the configuration
Returns:
the client/**
   * Like {@link #createShared(io.vertx.core.Vertx, JsonObject, String)} but with the default pool name
   *
   * @param vertx   the Vert.x instance
   * @param config  the configuration
   * @return the client
   */
  static AsyncSQLClient createShared(Vertx vertx, JsonObject config) {
    return ClientHelper.getOrCreate(vertx, config, DEFAULT_POOL_NAME, true);
  }


}