/*
  Copyright 2009 Nathan Phillip Brink, Ethan Zonca, Matthew Orlando

  This file is a part of DistRen.

  DistRen is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  DistRen is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License
  along with DistRen.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef MYSQL_H_
#define MYSQL_H_

struct distrend_mysql_con;
struct distrend_mysql_result;

typedef struct distrend_mysql_con *distrend_mysql_con_t;
typedef struct distrend_mysql_result *distrend_mysql_result_t;

/**
   initiates a MySQL connection
   @param conn, pointer will be set to the struct
   @return 0 on success
 */
int mysqlConnect(distrend_mysql_con_t *conn);

/**
   cleans and disconnects MySQL connection
   @param conn connection to clean
   @return 0 on success
*/
int mysqlDisconnect(distrend_mysql_con_t conn);

/**
   performs mysql query.
   errors will be logged to the user by this function.
   @return pointer to query handle on success, NULL on failure
 */
distrend_mysql_result_t mysqlQuery(struct distrend_mysql_con *conn, char *query);

/**
   frees mysql query result.
   @return 0 on success
 */
int mysqlResultFree(distrend_mysql_result_t result);

#endif /* MYSQL_H_ */