KexiDB::MySqlCursor Class Reference

#include <mysqlcursor.h>

Inheritance diagram for KexiDB::MySqlCursor:


Public Member Functions
	MySqlCursor (Connection *conn, const QString &statement=QString::null, uint cursor_options=NoOptions)
	MySqlCursor (Connection *conn, QuerySchema &query, uint options=NoOptions)
virtual	~MySqlCursor ()
virtual bool	drv_open ()
virtual bool	drv_close ()
virtual void	drv_getNextRecord ()
virtual QVariant	value (uint)
virtual void	drv_clearServerResult ()
virtual void	drv_appendCurrentRecordToBuffer ()
virtual void	drv_bufferMovePointerNext ()
virtual void	drv_bufferMovePointerPrev ()
virtual void	drv_bufferMovePointerTo (Q_LLONG to)
virtual const char **	rowData () const
virtual void	storeCurrentRow (RowData &data) const
virtual int	serverResult ()
virtual QString	serverResultName ()
virtual QString	serverErrorMsg ()
Protected Member Functions
QVariant	pValue (uint pos) const
Protected Attributes
MySqlCursorData *	d
	for future extensions

Constructor & Destructor Documentation

MySqlCursor::MySqlCursor ( Connection * conn,

const QString & statement = QString::null,

uint cursor_options = NoOptions

)

Definition at line 34 of file mysqlcursor.cpp.
References KexiDB::Cursor::Buffered, d, and KexiDB::Cursor::m_options.

MySqlCursor::MySqlCursor ( Connection * conn,

QuerySchema & query,

uint options = NoOptions

)

Definition at line 43 of file mysqlcursor.cpp.
References KexiDB::Cursor::Buffered, d, and KexiDB::Cursor::m_options.

MySqlCursor::~MySqlCursor ( ) [virtual]

Definition at line 52 of file mysqlcursor.cpp.
References KexiDB::Cursor::close().

Member Function Documentation

void MySqlCursor::drv_appendCurrentRecordToBuffer ( ) [virtual]

Stores currently fetched record's values in appropriate place of the buffer. Note for driver developers: This place can be computed using m_at. Do not change value of m_at or any other Cursor members, only change your internal structures like pointer to current row, etc. If your database engine's API function (for record fetching) do not allocates such a space, you want to allocate a space for current record. Otherwise, reuse existing structure, what could be more efficient. All functions like drv_appendCurrentRecordToBuffer() operates on the buffer, i.e. array of stored rows. You are not forced to have any particular fixed structure for buffer item or buffer itself - the structure is internal and only methods like storeCurrentRecord() visible to public.
Implements KexiDB::Cursor.
Definition at line 169 of file mysqlcursor.cpp.

void MySqlCursor::drv_bufferMovePointerNext ( ) [virtual]

Moves pointer (that points to the buffer) -- to next item in this buffer. Note for driver developers: probably just execute "your_pointer++" is enough.
Implements KexiDB::Cursor.
Definition at line 173 of file mysqlcursor.cpp.
References d.

void MySqlCursor::drv_bufferMovePointerPrev ( ) [virtual]

Like drv_bufferMovePointerNext() but execute "your_pointer--".
Implements KexiDB::Cursor.
Definition at line 178 of file mysqlcursor.cpp.
References d, and KexiDB::Cursor::m_at.

void MySqlCursor::drv_bufferMovePointerTo ( Q_LLONG to ) [virtual]

Moves pointer (that points to the buffer) to a new place: at.
Implements KexiDB::Cursor.
Definition at line 186 of file mysqlcursor.cpp.
References d.

void MySqlCursor::drv_clearServerResult ( ) [virtual]

Clears an internal member that is used to storing last result code, the same that is returend by serverResult().
Implements KexiDB::Cursor.
Definition at line 208 of file mysqlcursor.cpp.
References d.

bool MySqlCursor::drv_close ( ) [virtual]

Implements KexiDB::Cursor.
Definition at line 79 of file mysqlcursor.cpp.
References d, and KexiDB::Cursor::m_opened.

void MySqlCursor::drv_getNextRecord ( ) [virtual]

Implements KexiDB::Cursor.
Definition at line 94 of file mysqlcursor.cpp.
References KexiDB::Cursor::at(), d, KexiDB::Cursor::FetchEnd, KexiDB::Cursor::FetchError, KexiDB::Cursor::FetchOK, and KexiDB::Cursor::m_result.

bool MySqlCursor::drv_open ( ) [virtual]

Implements KexiDB::Cursor.
Definition at line 56 of file mysqlcursor.cpp.
References d, ERR_DB_SPECIFIC, KexiDB::Cursor::m_afterLast, KexiDB::Cursor::m_at, KexiDB::Cursor::m_buffering_completed, KexiDB::Cursor::m_fieldCount, KexiDB::Cursor::m_opened, KexiDB::Cursor::m_records_in_buf, KexiDB::Object::m_sql, and KexiDB::Object::setError().

QVariant KexiDB::MySqlCursor::pValue ( uint pos ) const [protected]

const char ** MySqlCursor::rowData ( ) const [virtual]

Todo:

Implements KexiDB::Cursor.
Definition at line 193 of file mysqlcursor.cpp.

QString MySqlCursor::serverErrorMsg ( ) [virtual]

Returns:
(not i18n'd) description text (message) of last operation's error/result. In most cases engines do return such a messages, any user can then use this to refer a documentation. Note for driver developers: Leave the default implementation (null string is returned ) if your engine has no such capability.

Reimplemented from KexiDB::Cursor.
Definition at line 215 of file mysqlcursor.cpp.
References d.

int MySqlCursor::serverResult ( ) [virtual]

Returns:
a code of last executed operation's result at the server side. This code is engine dependent and may be even engine-version dependent. It can be visible in applications mainly after clicking a "Details>>" button or something like that -- this just can be useful for advanced users and for testing. Note for driver developers: Return here the value you usually store as result of most lower-level operations. By default this method returns 0.

Reimplemented from KexiDB::Cursor.
Definition at line 198 of file mysqlcursor.cpp.
References d.

QString MySqlCursor::serverResultName ( ) [virtual]

Returns:
(not i18n'd) name of last executed operation's result at the server side. Sometimes engines have predefined its result names that can be used e.g. to refer a documentation. SQLite is one of such engines. Note for driver developers: Leave the default implementation (null string is returned ) if your engine has no such capability.

Reimplemented from KexiDB::Cursor.
Definition at line 203 of file mysqlcursor.cpp.

void MySqlCursor::storeCurrentRow ( RowData & data ) const [virtual]

Todo:
js: use MYSQL_FIELD::type here! see SQLiteCursor::storeCurrentRow()

Implements KexiDB::Cursor.
Definition at line 137 of file mysqlcursor.cpp.
References KexiDB::cstringToVariant(), d, KexiDB::Cursor::m_fieldCount, and KexiDB::Cursor::m_fieldsExpanded.

QVariant MySqlCursor::value ( uint pos ) [virtual]

Todo:
js: use MYSQL_FIELD::type here!

Implements KexiDB::Cursor.
Definition at line 109 of file mysqlcursor.cpp.
References KexiDB::cstringToVariant(), d, KexiDB::Cursor::m_fieldCount, and KexiDB::Cursor::m_fieldsExpanded.

Member Data Documentation

MySqlCursorData* KexiDB::MySqlCursor::d [protected]

for future extensions

Reimplemented from KexiDB::Cursor.
Definition at line 63 of file mysqlcursor.h.
Referenced by drv_bufferMovePointerNext(), drv_bufferMovePointerPrev(), drv_bufferMovePointerTo(), drv_clearServerResult(), drv_close(), drv_getNextRecord(), drv_open(), MySqlCursor(), serverErrorMsg(), serverResult(), storeCurrentRow(), and value().

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

Kexi API Documentation (2.0 alpha)

KexiDB::MySqlCursor Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation