DB::MySQL_Connection Class Reference

#include <mysql_db.h>

Inheritance diagram for DB::MySQL_Connection:

List of all members.

Public Member Functions
	MySQL_Connection ()
	~MySQL_Connection ()
bool	open (const char *database, const char *host, const int port, const char *user, const char *pass)
bool	close (void)
bool	isConnected (void)
bool	execute (const char *sql)
ResultSet *	executeQuery (const char *sql)
char *	escape (const char *)
const char *	unixtimeToSql (const time_t)
const unsigned long	insertId (void)
bool	beginTrans (void)
bool	commitTrans (void)
bool	rollbackTrans (void)
bool	setTransactionMode (const enum TRANS_MODE mode)
unsigned int	errorno (void) const
const char *	errormsg (void) const
const char *	version (void) const
void *	operator new (size_t bytes)
void	operator delete (void *ptr)
Private Member Functions
	MySQL_Connection (const MySQL_Connection &old)
const MySQL_Connection &	operator= (const MySQL_Connection &old)
Private Attributes
MYSQL *	mysql_

---

Detailed Description

Definition at line 76 of file mysql_db.h.

---

Constructor & Destructor Documentation

DB::MySQL_Connection::MySQL_Connection

(

const MySQL_Connection &

old

)

[private]

DB::MySQL_Connection::MySQL_Connection

(

)

[inline]

Definition at line 83 of file mysql_db.h.

: mysql_(NULL) {};

DB::MySQL_Connection::~MySQL_Connection

(

)

[inline]

Definition at line 84 of file mysql_db.h.

References close().

{ close(); }

---

Member Function Documentation

bool DB::MySQL_Connection::beginTrans

(

void

)

[virtual]

Begins a new transaction. If for some reason it fails, false will be returned (for instance, if the underlying driver does not support transactions.)

Returns:

bool

Implements DB::Connection.

Definition at line 313 of file mysql_db.cpp.

References mysql_.

{
    if (!mysql_) return (false);
    if (mysql_query(mysql_, "SET AUTOCOMMIT = 0") != 0) {
        return (false);
    }
    if (mysql_query(mysql_, "BEGIN") == 0) {
        return (true);
    }
    return (false);
}

bool DB::MySQL_Connection::close

(

void

)

[virtual]

Close the database connection

Returns:

bool True if successful.

Implements DB::Connection.

Definition at line 239 of file mysql_db.cpp.

References mysql_.

Referenced by ~MySQL_Connection().

{
    if (!mysql_) return (false);
    mysql_close(mysql_);
    mysql_ = NULL;
    return (true);
}

bool DB::MySQL_Connection::commitTrans

(

void

)

[virtual]

Attempts to commit the current transaction

Returns:

bool

Implements DB::Connection.

Definition at line 326 of file mysql_db.cpp.

References mysql_.

{
    if (!mysql_) return (false);
    if (mysql_query(mysql_, "COMMIT") == 0) {
        return (true);
    }
    return (false);
}

const char * DB::MySQL_Connection::errormsg

(

void

)

const [virtual]

Returns a textual representation of the last error to occur. The value returned should NOT be freed.

Returns:

const char*

Implements DB::Connection.

Definition at line 376 of file mysql_db.cpp.

References mysql_.

{
    return (mysql_error(mysql_));
}

unsigned int DB::MySQL_Connection::errorno

(

void

)

const [virtual]

Returns the last error code to occur.

Returns:

unsigned int

Implements DB::Connection.

Definition at line 370 of file mysql_db.cpp.

References mysql_.

{
    return (mysql_errno(mysql_));
}

char * DB::MySQL_Connection::escape

(

const char *

)

[virtual]

Returns a database specific escaped string from the input. The string returned must be freed by the caller. This is used by the Query class.

Returns:

char*

Implements DB::Connection.

Definition at line 282 of file mysql_db.cpp.

{
    unsigned long len = strlen(str);
    char *buf = new char[len*2+4];
    buf[0] = '\'';
    len = mysql_escape_string(buf+1, str, len);
    buf[++len] = '\'';
    buf[++len] = 0;
    return (buf);
}

bool DB::MySQL_Connection::execute

(

const char *

sql

)

[virtual]

Executes a query to the database, discarding any result data. This function is typically used for non-SELECT statements.

Parameters:

sql

Returns:

bool

Implements DB::Connection.

Definition at line 255 of file mysql_db.cpp.

References mysql_.

Referenced by setTransactionMode().

{
    if (!mysql_) return (false);
    if (mysql_query(mysql_, sql) == 0) {
        return (true);
    }
    return (false);
}

DB::ResultSet * DB::MySQL_Connection::executeQuery

(

const char *

sql

)

[virtual]

Executes a query to the database which returns row data. The row data is manipulated using the ResultSet object returned by this method. If the database wasn't able to return row data or an error occurs, then zero is returned. Therefore be careful to check the returned value, before using it - or a seg. fault is possible!

Parameters:

sql

Returns:

ResultSet*

Implements DB::Connection.

Definition at line 265 of file mysql_db.cpp.

References mysql_.

{
    if (!mysql_) return (false);

    if (mysql_query(mysql_, sql)) {
        return (0);
    }
    MYSQL_RES *res = mysql_use_result(mysql_);
    if (!res) {
        return (0);
    }
    DB::ResultSet *c = 0;
    ACE_NEW_RETURN (c, DB::MySQL_ResultSet(res), 0);
    return (c);
}

const unsigned long DB::MySQL_Connection::insertId

(

void

)

[virtual]

Returns the last SQL INSERT unique identifier if the underlying database supports this feature.

Returns:

const unsigned long

Implements DB::Connection.

Definition at line 307 of file mysql_db.cpp.

References mysql_.

{
    return ((const unsigned long) mysql_insert_id(mysql_));
}

bool DB::MySQL_Connection::isConnected

(

void

)

[virtual]

Attempts to tell if we are still connected to the database.

Returns:

bool

Implements DB::Connection.

Definition at line 248 of file mysql_db.cpp.

References mysql_.

{
    if (!mysql_) return (false);
    return ((mysql_ping(mysql_) == 0 ? true : false));
}

bool DB::MySQL_Connection::open	(	const char *	database,
		const char *	host,
		const int	port,
		const char *	user,
		const char *	pass
	)			[virtual]

Open a connection to a database.

Parameters:

	database	Database name. Sqlite3 uses this for the filename.
	host	Hostname
	port	Port
	user	Username
	pass	Password

Returns:

bool True if successful.

Implements DB::Connection.

Definition at line 215 of file mysql_db.cpp.

References mysql_.

{
    if ((mysql_ = mysql_init(NULL)) == NULL) {
        return (false);
    }
    if (mysql_real_connect(
            mysql_, 
            host, 
            user, 
            pass, 
            NULL, 
            (unsigned)port, 
            NULL, 
            0
            ) == NULL) {
        return (false);
    }
    if (mysql_select_db(mysql_, database) != 0) {
        return (false);
    }
    return (true);
}

void DB::MySQL_Connection::operator delete

(

void *

ptr

)

Definition at line 409 of file mysql_db.cpp.

{
  delete [] static_cast <char *> (ptr);
}

void * DB::MySQL_Connection::operator new

(

size_t

bytes

)

Definition at line 390 of file mysql_db.cpp.

{
  return (::new char[bytes]);
}

const MySQL_Connection& DB::MySQL_Connection::operator=

(

const MySQL_Connection &

old

)

[private]

bool DB::MySQL_Connection::rollbackTrans

(

void

)

[virtual]

Attempts to rollback the current transaction

Returns:

bool

Implements DB::Connection.

Definition at line 336 of file mysql_db.cpp.

References mysql_.

{
    if (!mysql_) return (false);
    if (mysql_query(mysql_, "ROLLBACK") == 0) {
        return (true);
    }
    return (false);
}

bool DB::MySQL_Connection::setTransactionMode

(

const enum TRANS_MODE

mode

)

Definition at line 346 of file mysql_db.cpp.

References execute(), DB::Connection::READ_COMMITTED, DB::Connection::READ_UNCOMMITTED, DB::Connection::REPEATABLE_READ, and DB::Connection::SERIALIZABLE.

{
    const char *sql = "";

    switch (mode) {
    case READ_UNCOMMITTED:
        sql = "SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED";
        break;
    case READ_COMMITTED:
        sql = "SET SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED";
        break;
    case REPEATABLE_READ:
        sql = "SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ";
        break;
    case SERIALIZABLE:
        sql = "SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE";
        break;
    default:
        return false;
    }
    return (execute(sql));
}

const char * DB::MySQL_Connection::unixtimeToSql

(

const

time_t

)

[virtual]

Returns a database specific representation of the time_t value. This is used by the Query class. The string returned must be freed by the caller.

Parameters:

time_t

Returns:

const char*

Implements DB::Connection.

Definition at line 294 of file mysql_db.cpp.

{
    char *buf = new char[22];
    struct tm *tmp = new struct tm;
    buf[0] = '\'';
    ACE_OS::strftime(buf+1, 20, "%Y-%m-%d %H:%M:%S", ACE_OS::localtime_r(&val, tmp));
    buf[20] = '\'';
    buf[21] = 0;
    delete tmp;
    return (buf);
}

const char * DB::MySQL_Connection::version

(

void

)

const [virtual]

Returns the DB abstraction module's version number and possibly the version of the underlying database client library used. The returned value should NOT be freed.

Returns:

const char*

Implements DB::Connection.

Definition at line 382 of file mysql_db.cpp.

{
    static char ret[256];
    ACE_OS::snprintf(ret, 256, "MySQL Driver v0.1 using MySQL client library v%s", mysql_get_client_info());
    return ((const char *) ret);
}

---

Member Data Documentation

MYSQL* DB::MySQL_Connection::mysql_ [private]

Definition at line 119 of file mysql_db.h.

Referenced by beginTrans(), close(), commitTrans(), errormsg(), errorno(), execute(), executeQuery(), insertId(), isConnected(), open(), and rollbackTrans().

---

The documentation for this class was generated from the following files:

• mysql_db.h
• mysql_db.cpp

---