KexiDB::pqxxSqlConnection Class Reference

#include <pqxxconnection.h>

Inheritance diagram for KexiDB::pqxxSqlConnection:

Detailed Description

Author:: Adam Pigg

Definition at line 48 of file pqxxconnection.h.

Public Member Functions

virtual ~pqxxSqlConnection ()

virtual Cursor * prepareQuery (const QString &statement=QString::null, uint cursor_options=0)

virtual Cursor * prepareQuery (QuerySchema &query, uint cursor_options=0)

virtual PreparedStatement::Ptr prepareStatement (PreparedStatement::StatementType type, FieldList &fields)

Protected Member Functions

pqxxSqlConnection (Driver *driver, ConnectionData &conn_data)

virtual bool drv_isDatabaseUsed () const

virtual bool drv_connect (KexiDB::ServerVersionInfo &version)

virtual bool drv_disconnect ()

virtual bool drv_getDatabasesList (QStringList &list)

virtual bool drv_createDatabase (const QString &dbName=QString::null)

virtual bool drv_useDatabase (const QString &dbName=QString::null, bool *cancelled=0, MessageHandler *msgHandler=0)

virtual bool drv_closeDatabase ()

virtual bool drv_dropDatabase (const QString &dbName=QString::null)

virtual bool drv_executeSQL (const QString &statement)

virtual Q_ULLONG drv_lastInsertRowID ()

virtual bool drv_getTablesList (QStringList &list)

virtual bool drv_containsTable (const QString &tableName)

virtual TransactionData * drv_beginTransaction ()

virtual bool drv_commitTransaction (TransactionData *)

virtual bool drv_rollbackTransaction (TransactionData *)

virtual int serverResult ()

virtual QString serverResultName ()

virtual void drv_clearServerResult ()

virtual QString serverErrorMsg ()

Protected Attributes

pqxxSqlConnectionInternal * d

for future extensions

Friends

class pqxxSqlDriver

class pqxxSqlCursor

class pqxxTransactionData

Constructor & Destructor Documentation

pqxxSqlConnection::~pqxxSqlConnection ( ) [virtual]

Definition at line 64 of file pqxxconnection.cpp.
References d, and KexiDB::Connection::destroy().

pqxxSqlConnection::pqxxSqlConnection ( Driver * driver,

ConnectionData & conn_data

) [protected]

Definition at line 55 of file pqxxconnection.cpp.

Member Function Documentation

TransactionData * pqxxSqlConnection::drv_beginTransaction ( ) [protected, virtual]

Note for driver developers: begins new transaction and returns handle to it. Default implementation just executes "BEGIN" sql statement and returns just empty data (TransactionData object).
Drivers that do not support transactions (see Driver::features()) do never call this method. Reimplement this method if you need to do something more (e.g. if you driver will support multiple transactions per connection). Make subclass of TransactionData (declared in transaction.h) and return object of this subclass. You should return NULL if any error occurred. Do not check anything in connection (isConnected(), etc.) - all is already done.
Reimplemented from KexiDB::Connection.
Definition at line 368 of file pqxxconnection.cpp.
References pqxxTransactionData.

void pqxxSqlConnection::drv_clearServerResult ( ) [protected, virtual]

Clears number of last server operation's result stored as a single integer. Formally, this integer should be set to value that means "NO ERRORS" or "OK". This method is called by clearError(). For reimplementation. By default does nothing.
See also:
serverErrorMsg()

Reimplemented from KexiDB::Object.
Definition at line 427 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::resultCode.

bool pqxxSqlConnection::drv_closeDatabase ( ) [protected, virtual]

For reimplemenation: closes previously opened database using connection.
Implements KexiDB::Connection.
Definition at line 228 of file pqxxconnection.cpp.
References d, KexiDBDrvDbg, and KexiDB::pqxxSqlConnectionInternal::pqxxsql.

bool pqxxSqlConnection::drv_commitTransaction ( TransactionData * tdata ) [protected, virtual]

Todo:

Reimplemented from KexiDB::Connection.
Definition at line 373 of file pqxxconnection.cpp.
References d, KexiDB::pqxxSqlConnectionInternal::errmsg, and KexiDB::Object::setError().
Referenced by drv_executeSQL().

bool pqxxSqlConnection::drv_connect ( KexiDB::ServerVersionInfo & version ) [protected, virtual]

For reimplemenation: connects to database. version should be set to real server's version.
Returns:
true on success.

Implements KexiDB::Connection.
Definition at line 97 of file pqxxconnection.cpp.
References KexiDB::ServerVersionInfo::clear(), d, KexiDBDrvDbg, and KexiDB::pqxxSqlConnectionInternal::version.

bool pqxxSqlConnection::drv_containsTable ( const QString & tableName ) [protected, virtual]

LOW LEVEL METHOD. For reimplemenation: returns true if table with name tableName exists in the database.
Returns:
false if it does not exist or error occurred. The lookup is case insensitive.

Implements KexiDB::Connection.
Definition at line 339 of file pqxxconnection.cpp.
References KexiDB::Connection::driver(), and KexiDB::Connection::resultExists().

bool pqxxSqlConnection::drv_createDatabase ( const QString & dbName = QString::null ) [protected, virtual]

For reimplemenation: creates new database using connection
Implements KexiDB::Connection.
Definition at line 141 of file pqxxconnection.cpp.
References KexiDB::Connection::executeSQL(), and KexiDBDrvDbg.

bool pqxxSqlConnection::drv_disconnect ( ) [protected, virtual]

For reimplemenation: disconnects database
Returns:
true on success.

Implements KexiDB::Connection.
Definition at line 111 of file pqxxconnection.cpp.
References KexiDBDrvDbg.

bool pqxxSqlConnection::drv_dropDatabase ( const QString & dbName = QString::null ) [protected, virtual]

For reimplemenation: drops database from the server using connection. After drop, database shouldn't be accessible anymore.
Implements KexiDB::Connection.
Definition at line 247 of file pqxxconnection.cpp.
References KexiDB::Connection::executeSQL(), and KexiDBDrvDbg.

bool pqxxSqlConnection::drv_executeSQL ( const QString & statement ) [protected, virtual]

Executes query statement, but without returning resulting rows (used mostly for functional queries). Only use this method if you really need.
Implements KexiDB::Connection.
Definition at line 260 of file pqxxconnection.cpp.
References d, KexiDB::pqxxTransactionData::data, drv_commitTransaction(), KexiDB::pqxxSqlConnectionInternal::errmsg, KexiDBDrvDbg, pqxxTransactionData, and KexiDB::pqxxSqlConnectionInternal::res.
Referenced by drv_useDatabase().

bool pqxxSqlConnection::drv_getDatabasesList ( QStringList & list ) [protected, virtual]

For reimplemenation: loads list of databases' names available for this connection and adds these names to list. If your server is not able to offer such a list, consider reimplementing drv_databaseExists() instead. The method should return true only if there was no error on getting database names list from the server. Default implementation puts empty list into list and returns true.
Reimplemented from KexiDB::Connection.
Definition at line 119 of file pqxxconnection.cpp.
References d, KexiDB::Connection::executeSQL(), and KexiDB::pqxxSqlConnectionInternal::res.

bool pqxxSqlConnection::drv_getTablesList ( QStringList & list ) [protected, virtual]

LOW LEVEL METHOD. For reimplemenation: loads low-level list of table names available for this connection. The names are in lower case. The method should return true only if there was no error on getting database names list from the server.
Implements KexiDB::Connection.
Definition at line 346 of file pqxxconnection.cpp.
References KexiDB::Connection::deleteCursor(), KexiDB::Cursor::eof(), KexiDB::Object::error(), KexiDB::Connection::executeQuery(), KexiDBDrvWarn, KexiDB::Object::m_sql, KexiDB::Cursor::moveFirst(), KexiDB::Cursor::moveNext(), and KexiDB::Cursor::value().

bool pqxxSqlConnection::drv_isDatabaseUsed ( ) const [protected, virtual]

Returns:
true if internal driver's structure is still in opened/connected state and database is used. Note for driver developers: Put here every test that you can do using your internal engine's database API, eg (a bit schematic): my_connection_struct->isConnected()==true. Do not check things like Connection::isDatabaseUsed() here or other things that "KexiDB already knows" at its level. If you cannot test anything, just leave default implementation (that returns true).
Result of this method is used as an addtional chance to check for isDatabaseUsed(). Do not call this method from your driver's code, it should be used at KexiDB level only.
Reimplemented from KexiDB::Connection.
Definition at line 309 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::pqxxsql.

Q_ULLONG pqxxSqlConnection::drv_lastInsertRowID ( ) [protected, virtual]

Returns:
unique identifier of last inserted row. Typically this is just primary key value. This identifier could be reused when we want to reference just inserted row. Note for driver developers: contact js (at) iidea.pl if your engine do not offers this information.

Implements KexiDB::Connection.
Definition at line 320 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::res.

bool pqxxSqlConnection::drv_rollbackTransaction ( TransactionData * ) [protected, virtual]

Note for driver developers: begins new transaction and returns handle to it. Default implementation just executes "ROLLBACK" sql statement and returns true on success.

See also:
drv_beginTransaction()

Reimplemented from KexiDB::Connection.
Definition at line 395 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::errmsg.

bool pqxxSqlConnection::drv_useDatabase ( const QString & dbName = QString::null,

bool * cancelled = 0,

MessageHandler * msgHandler = 0

) [protected, virtual]

Todo:
set version using the connection pointer when we drop libpqxx for libpq

Implements KexiDB::Connection.
Definition at line 153 of file pqxxconnection.cpp.
References d, KexiDB::Connection::data(), drv_executeSQL(), KexiDB::pqxxSqlConnectionInternal::errmsg, KexiDBDrvDbg, KexiDB::pqxxSqlConnectionInternal::pqxxsql, and KexiDB::pqxxSqlConnectionInternal::version.

Cursor * pqxxSqlConnection::prepareQuery ( QuerySchema & query,

uint cursor_options = 0

) [virtual]

Implements KexiDB::Connection.
Definition at line 81 of file pqxxconnection.cpp.
References pqxxSqlCursor.

Cursor * pqxxSqlConnection::prepareQuery ( const QString & statement = QString::null,

uint cursor_options = 0

) [virtual]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Statement is build from data provided by table schema, it is like "select * from table_name".
Implements KexiDB::Connection.
Definition at line 73 of file pqxxconnection.cpp.
References pqxxSqlCursor.

PreparedStatement::Ptr pqxxSqlConnection::prepareStatement ( PreparedStatement::StatementType type,

FieldList & fields

) [virtual]

Prepare a SQL statement and return a PreparedStatement instance.
Implements KexiDB::Connection.
Definition at line 437 of file pqxxconnection.cpp.
References d.

QString pqxxSqlConnection::serverErrorMsg ( ) [protected, virtual]

KexiDB library offers detailed error numbers using errorNum() and detailed error i18n'd messages using errorMsg() - this information is not engine-dependent (almost). Use this in your application to give users more information on what's up.
This method returns (non-i18n'd !) engine-specific error message, if there was any error during last server-side operation, otherwise null string. Reimplement this for your driver

default implementation just returns null string.
See also:
serverErrorMsg()

Reimplemented from KexiDB::Object.
Definition at line 432 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::errmsg.

int pqxxSqlConnection::serverResult ( ) [protected, virtual]

Returns:
engine-specific last server-side operation result number. Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns 0. Note that this result value is not the same as the one returned by errorNum() (Object::m_errno member)
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.
Definition at line 417 of file pqxxconnection.cpp.
References d, and KexiDB::pqxxSqlConnectionInternal::resultCode.

QString pqxxSqlConnection::serverResultName ( ) [protected, virtual]

Returns:
engine-specific last server-side operation result name, (name for serverResult()). Use this in your application to give users more information on what's up.
Reimplement this for your driver - default implementation just returns null string. Note that this result name is not the same as the error message returned by serverErorMsg() or erorMsg()
See also:
serverErrorMsg(), drv_clearServerResult()

Reimplemented from KexiDB::Object.
Definition at line 422 of file pqxxconnection.cpp.

Friends And Related Function Documentation

friend class pqxxSqlCursor [friend]

Definition at line 100 of file pqxxconnection.h.
Referenced by prepareQuery().

friend class pqxxSqlDriver [friend]

Definition at line 99 of file pqxxconnection.h.

friend class pqxxTransactionData [friend]

Definition at line 101 of file pqxxconnection.h.
Referenced by drv_beginTransaction(), and drv_executeSQL().

Member Data Documentation

pqxxSqlConnectionInternal* KexiDB::pqxxSqlConnection::d [protected]

for future extensions

Reimplemented from KexiDB::Connection.
Definition at line 90 of file pqxxconnection.h.
Referenced by drv_clearServerResult(), drv_closeDatabase(), drv_commitTransaction(), drv_connect(), drv_executeSQL(), drv_getDatabasesList(), drv_isDatabaseUsed(), drv_lastInsertRowID(), drv_rollbackTransaction(), drv_useDatabase(), prepareStatement(), serverErrorMsg(), serverResult(), and ~pqxxSqlConnection().

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


Public Member Functions
virtual	~pqxxSqlConnection ()
virtual Cursor *	prepareQuery (const QString &statement=QString::null, uint cursor_options=0)
virtual Cursor *	prepareQuery (QuerySchema &query, uint cursor_options=0)
virtual PreparedStatement::Ptr	prepareStatement (PreparedStatement::StatementType type, FieldList &fields)
Protected Member Functions
	pqxxSqlConnection (Driver *driver, ConnectionData &conn_data)
virtual bool	drv_isDatabaseUsed () const
virtual bool	drv_connect (KexiDB::ServerVersionInfo &version)
virtual bool	drv_disconnect ()
virtual bool	drv_getDatabasesList (QStringList &list)
virtual bool	drv_createDatabase (const QString &dbName=QString::null)
virtual bool	drv_useDatabase (const QString &dbName=QString::null, bool cancelled=0, MessageHandler msgHandler=0)
virtual bool	drv_closeDatabase ()
virtual bool	drv_dropDatabase (const QString &dbName=QString::null)
virtual bool	drv_executeSQL (const QString &statement)
virtual Q_ULLONG	drv_lastInsertRowID ()
virtual bool	drv_getTablesList (QStringList &list)
virtual bool	drv_containsTable (const QString &tableName)
virtual TransactionData *	drv_beginTransaction ()
virtual bool	drv_commitTransaction (TransactionData *)
virtual bool	drv_rollbackTransaction (TransactionData *)
virtual int	serverResult ()
virtual QString	serverResultName ()
virtual void	drv_clearServerResult ()
virtual QString	serverErrorMsg ()
Protected Attributes
pqxxSqlConnectionInternal *	d
	for future extensions
Friends
class	pqxxSqlDriver
class	pqxxSqlCursor
class	pqxxTransactionData

Kexi API Documentation (2.0 alpha)

KexiDB::pqxxSqlConnection Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation