MysqlConnection

#include <MysqlConnection.h>

Inheritance diagram for MysqlConnection:

[legend]

Public Member Functions
KDbCursor *	prepareQuery (const KDbEscapedString &sql, KDbCursor::Options options=KDbCursor::Option::None) override

KDbCursor *	prepareQuery (KDbQuerySchema *query, KDbCursor::Options options=KDbCursor::Option::None) override

KDbPreparedStatementInterface *	prepareStatementInternal () override

Public Member Functions inherited from KDbConnection
	~KDbConnection () override

tristate	alterTable (KDbTableSchema tableSchema, KDbTableSchema newTableSchema)

bool	alterTableName (KDbTableSchema *tableSchema, const QString &newName, AlterTableNameOptions options=AlterTableNameOption::Default)

virtual QString	anyAvailableDatabaseName ()

bool	autoCommit () const

KDbTransaction	beginTransaction ()

void	clearResult ()

bool	closeDatabase ()

bool	commitTransaction (KDbTransaction transaction=KDbTransaction(), KDbTransaction::CommitOptions options=KDbTransaction::CommitOptions())

bool	connect ()

tristate	containsTable (const QString &tableName)

bool	copyDataBlock (int sourceObjectID, int destObjectID, const QString &dataID=QString())

KDbTableSchema *	copyTable (const KDbTableSchema &tableSchema, const KDbObject &newData)

KDbTableSchema *	copyTable (const QString &tableName, const KDbObject &newData)

bool	createDatabase (const QString &dbName)

bool	createTable (KDbTableSchema *tableSchema, CreateTableOptions options=CreateTableOption::Default)

QString	currentDatabase () const

KDbConnectionData	data () const

bool	databaseExists (const QString &dbName, bool ignoreErrors=true)

QStringList	databaseNames (bool also_system_db=false)

KDbProperties	databaseProperties () const

KDbVersionInfo	databaseVersion () const

KDbTransaction	defaultTransaction () const

bool	deleteCursor (KDbCursor *cursor)

bool	disconnect ()

KDbDriver *	driver () const

bool	dropDatabase (const QString &dbName=QString())

bool	dropQuery (const QString &queryName)

bool	dropQuery (KDbQuerySchema *querySchema)

tristate	dropTable (const QString &tableName)

tristate	dropTable (KDbTableSchema *tableSchema)

virtual QString	escapeIdentifier (const QString &id) const

virtual KDbEscapedString	escapeString (const QString &str) const

KDbCursor *	executeQuery (const KDbEscapedString &sql, KDbCursor::Options options=KDbCursor::Option::None)

KDbCursor *	executeQuery (KDbQuerySchema *query, const QList< QVariant > &params, KDbCursor::Options options=KDbCursor::Option::None)

KDbCursor *	executeQuery (KDbQuerySchema *query, KDbCursor::Options options=KDbCursor::Option::None)

KDbCursor *	executeQuery (KDbTableSchema *table, KDbCursor::Options options=KDbCursor::Option::None)

bool	executeSql (const KDbEscapedString &sql)

KDbField *	findSystemFieldName (const KDbFieldList &fieldlist)

QSharedPointer< KDbSqlResult >	insertRecord (KDbFieldList *fields, const QList< QVariant > &values)

QSharedPointer< KDbSqlResult >	insertRecord (KDbTableSchema *tableSchema, const QList< QVariant > &values)

bool	isConnected () const

bool	isDatabaseUsed () const

tristate	isEmpty (KDbTableSchema *table)

bool	isInternalTableSchema (const QString &tableName)

tristate	loadDataBlock (int objectID, QString *dataString, const QString &dataID=QString())

tristate	loadObjectData (int type, const QString &name, KDbObject *object)

tristate	loadObjectData (int type, int id, KDbObject *object)

QList< int >	objectIds (int objectType, bool *ok=nullptr)

QStringList	objectNames (int objectType=KDb::AnyObjectType, bool *ok=nullptr)

KDbConnectionOptions *	options ()

KDbCursor *	prepareQuery (KDbQuerySchema *query, const QList< QVariant > &params, KDbCursor::Options options=KDbCursor::Option::None)

KDbCursor *	prepareQuery (KDbTableSchema *table, KDbCursor::Options options=KDbCursor::Option::None)

QSharedPointer< KDbSqlResult >	prepareSql (const KDbEscapedString &sql)

KDbPreparedStatement	prepareStatement (KDbPreparedStatement::Type type, KDbFieldList *fields, const QStringList &whereFieldNames=QStringList())

QList< int >	queryIds (bool *ok=nullptr)

KDbQuerySchema *	querySchema (const QString &queryName)

KDbQuerySchema *	querySchema (int queryId)

tristate	querySingleNumber (const KDbEscapedString &sql, int *number, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleNumber (KDbQuerySchema query, int number, const QList< QVariant > &params, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleNumber (KDbQuerySchema query, int number, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleRecord (const KDbEscapedString &sql, KDbRecordData *data, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleRecord (KDbQuerySchema query, KDbRecordData data, const QList< QVariant > &params, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleRecord (KDbQuerySchema query, KDbRecordData data, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleString (const KDbEscapedString &sql, QString *value, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleString (KDbQuerySchema query, QString value, const QList< QVariant > &params, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

tristate	querySingleString (KDbQuerySchema query, QString value, int column=0, QueryRecordOptions options=QueryRecordOption::Default)

bool	queryStringList (const KDbEscapedString &sql, QStringList *list, int column=0)

bool	queryStringList (KDbQuerySchema query, QStringList list, const QList< QVariant > &params, int column=0)

bool	queryStringList (KDbQuerySchema query, QStringList list, int column=0)

virtual KDbEscapedString	recentSqlString () const

int	recordCount (const KDbEscapedString &sql)

int	recordCount (const KDbTableSchema &tableSchema)

int	recordCount (KDbQuerySchema *querySchema, const QList< QVariant > &params=QList< QVariant >())

int	recordCount (KDbTableOrQuerySchema *tableOrQuery, const QList< QVariant > &params=QList< QVariant >())

bool	removeDataBlock (int objectID, const QString &dataID=QString())

bool	removeObject (int objId)

tristate	resultExists (const KDbEscapedString &sql, QueryRecordOptions options=QueryRecordOption::Default)

bool	rollbackTransaction (KDbTransaction trans=KDbTransaction(), KDbTransaction::CommitOptions options=KDbTransaction::CommitOptions())

KDbServerVersionInfo	serverVersion () const

bool	setAutoCommit (bool on)

void	setAvailableDatabaseName (const QString &dbName)

void	setDefaultTransaction (const KDbTransaction &trans)

bool	setQuerySchemaObsolete (const QString &queryName)

bool	storeDataBlock (int objectID, const QString &dataString, const QString &dataID=QString())

bool	storeNewObjectData (KDbObject *object)

bool	storeObjectData (KDbObject *object)

QList< int >	tableIds (bool *ok=nullptr)

QStringList	tableNames (bool alsoSystemTables=false, bool *ok=nullptr)

KDbTableSchema *	tableSchema (const QString &tableName)

KDbTableSchema *	tableSchema (int tableId)

QList< KDbTransaction >	transactions ()

bool	useDatabase (const QString &dbName=QString(), bool kexiCompatible=true, bool cancelled=nullptr, KDbMessageHandler msgHandler=nullptr)

bool	useTemporaryDatabaseIfNeeded (QString *name)

Public Member Functions inherited from KDbResultable
	KDbResultable (const KDbResultable &other)

void	clearResult ()

KDbMessageHandler *	messageHandler () const

KDbResultable &	operator= (const KDbResultable &other)

KDbResult	result () const

void	setMessageHandler (KDbMessageHandler *handler)

void	showMessage ()

Protected Member Functions
	MysqlConnection (KDbDriver *driver, const KDbConnectionData &connData, const KDbConnectionOptions &options)

bool	drv_closeDatabase () override

bool	drv_connect () override

tristate	drv_containsTable (const QString &tableName) override

bool	drv_createDatabase (const QString &dbName=QString()) override

bool	drv_databaseExists (const QString &dbName, bool ignoreErrors=true) override

bool	drv_disconnect () override

bool	drv_dropDatabase (const QString &dbName=QString()) override

bool	drv_executeSql (const KDbEscapedString &sql) override

bool	drv_getDatabasesList (QStringList *list) override

bool	drv_getServerVersion (KDbServerVersionInfo *version) override

KDbSqlResult *	drv_prepareSql (const KDbEscapedString &sql) override

bool	drv_useDatabase (const QString &dbName=QString(), bool cancelled=nullptr, KDbMessageHandler msgHandler=nullptr) override

QString	serverResultName () const override

void	storeResult ()

Protected Member Functions inherited from KDbConnection
	KDbConnection (KDbDriver *driver, const KDbConnectionData &connData, const KDbConnectionOptions &options)

void	addCursor (KDbCursor *cursor)

bool	beginAutoCommitTransaction (KDbTransactionGuard *tg)

bool	checkConnected ()

bool	checkIfColumnExists (KDbCursor *cursor, int column)

bool	checkIsDatabaseUsed ()

bool	commitAutoCommitTransaction (const KDbTransaction &trans)

bool	deleteAllRecords (KDbQuerySchema *query)

bool	deleteRecord (KDbQuerySchema query, KDbRecordData data, bool useRecordId=false)

void	destroy ()

tristate	dropTableInternal (KDbTableSchema *tableSchema, bool alsoRemoveSchema)

virtual bool	drv_afterInsert (const QString &tableName, KDbFieldList *fields)

virtual bool	drv_afterUpdate (const QString &tableName, KDbFieldList *fields)

virtual bool	drv_alterTableName (KDbTableSchema *tableSchema, const QString &newName)

virtual bool	drv_beforeInsert (const QString &tableName, KDbFieldList *fields)

virtual bool	drv_beforeUpdate (const QString &tableName, KDbFieldList *fields)

virtual KDbTransactionData *	drv_beginTransaction ()

virtual tristate	drv_changeFieldProperty (KDbTableSchema table, KDbField field, const QString &propertyName, const QVariant &value)

virtual bool	drv_commitTransaction (KDbTransactionData *trans)

virtual bool	drv_copyTableData (const KDbTableSchema &tableSchema, const KDbTableSchema &destinationTableSchema)

virtual bool	drv_createTable (const KDbTableSchema &tableSchema)

virtual bool	drv_createTable (const QString &tableName)

virtual bool	drv_dropTable (const QString &tableName)

virtual QStringList	drv_getTableNames (bool *ok)

virtual bool	drv_isDatabaseUsed () const

virtual bool	drv_rollbackTransaction (KDbTransactionData *trans)

virtual bool	drv_setAutoCommit (bool on)

KDbCursor *	executeQueryInternal (const KDbEscapedString &sql, KDbQuerySchema query, const QList< QVariant > params)

bool	insertRecord (KDbQuerySchema query, KDbRecordData data, KDbRecordEditBuffer *buf, bool getRecordId=false)

QSharedPointer< KDbSqlResult >	insertRecordInternal (const QString &tableSchemaName, KDbFieldList *fields, const KDbEscapedString &sql)

bool	loadExtendedTableSchemaData (KDbTableSchema *tableSchema)

tristate	querySingleNumberInternal (const KDbEscapedString sql, int number, KDbQuerySchema query, const QList< QVariant > params, int column, QueryRecordOptions options)

tristate	querySingleRecordInternal (KDbRecordData data, const KDbEscapedString sql, KDbQuerySchema query, const QList< QVariant > params, QueryRecordOptions options)

tristate	querySingleStringInternal (const KDbEscapedString sql, QString value, KDbQuerySchema query, const QList< QVariant > params, int column, QueryRecordOptions options)

bool	queryStringListInternal (const KDbEscapedString sql, QStringList list, KDbQuerySchema query, const QList< QVariant > params, int column, bool(*filterFunction)(const QString &))

void	removeMe (KDbTableSchema *ts)

bool	rollbackAutoCommitTransaction (const KDbTransaction &trans)

KDbField *	setupField (const KDbRecordData &data)

bool	setupObjectData (const KDbRecordData &data, KDbObject *object)

bool	storeExtendedTableSchemaData (KDbTableSchema *tableSchema)

bool	storeMainFieldSchema (KDbField *field)

void	takeCursor (KDbCursor *cursor)

bool	updateRecord (KDbQuerySchema query, KDbRecordData data, KDbRecordEditBuffer *buf, bool useRecordId=false)

Protected Attributes
MysqlConnectionInternal *const	d

Protected Attributes inherited from KDbResultable
Private *const	d

KDbResult	m_result

Additional Inherited Members
Public Types inherited from KDbConnection
enum class	AlterTableNameOption { Default = 0 , DropDestination = 1 }

typedef QFlags< AlterTableNameOption >	AlterTableNameOptions

enum class	CreateTableOption { Default = 0 , DropDestination = 1 }

typedef QFlags< CreateTableOption >	CreateTableOptions

enum class	QueryRecordOption { AddLimitTo1 = 1 , Default = AddLimitTo1 }

typedef QFlags< QueryRecordOption >	QueryRecordOptions

Static Public Member Functions inherited from KDbConnection
static QStringList	kdbSystemTableNames ()

Public Attributes inherited from KDbConnection
	H_INS_REC_ALL

Detailed Description

Provides database connection, allowing queries and data modification.

Definition at line 33 of file MysqlConnection.h.

Constructor & Destructor Documentation

◆ ~MysqlConnection()

MysqlConnection::~MysqlConnection ( )

override

Definition at line 39 of file MysqlConnection.cpp.

◆ MysqlConnection()

MysqlConnection::MysqlConnection	(	KDbDriver *	driver,
		const KDbConnectionData &	connData,
		const KDbConnectionOptions &	options )

protected

Used by driver

Definition at line 32 of file MysqlConnection.cpp.

Member Function Documentation

◆ drv_closeDatabase()

bool MysqlConnection::drv_closeDatabase ( )

overrideprotectedvirtual

For implementation: closes previously opened database using connection.

Todo: free resources, as far as I know, mysql doesn't support that

Implements KDbConnection.

Definition at line 163 of file MysqlConnection.cpp.

◆ drv_connect()

bool MysqlConnection::drv_connect ( )

overrideprotectedvirtual

For implementation: connects to database.

Returns: true on success.

Implements KDbConnection.

Definition at line 45 of file MysqlConnection.cpp.

◆ drv_containsTable()

tristate MysqlConnection::drv_containsTable ( const QString & tableName )

overrideprotectedvirtual

Todo: move this somewhere to low level class (MIGRATION?)

Implements KDbConnection.

Definition at line 200 of file MysqlConnection.cpp.

◆ drv_createDatabase()

bool MysqlConnection::drv_createDatabase ( const QString & dbName = QString() )

overrideprotectedvirtual

For implementation: creates new database using connection

Implements KDbConnection.

Definition at line 141 of file MysqlConnection.cpp.

◆ drv_databaseExists()

bool MysqlConnection::drv_databaseExists	(	const QString &	dbName,
		bool	ignoreErrors = true )

overrideprotectedvirtual

reimplemented using "SHOW DATABASES LIKE..." because MySQL stores db names in lower case.

Reimplemented from KDbConnection.

Definition at line 125 of file MysqlConnection.cpp.

◆ drv_disconnect()

bool MysqlConnection::drv_disconnect ( )

overrideprotectedvirtual

For implementation: disconnects database

Returns: true on success.

Implements KDbConnection.

Definition at line 93 of file MysqlConnection.cpp.

◆ drv_dropDatabase()

bool MysqlConnection::drv_dropDatabase ( const QString & dbName = QString() )

overrideprotectedvirtual

For implementation: drops database from the server using connection. After drop, database shouldn't be accessible anymore.

Todo: is here escaping needed?

Implements KDbConnection.

Definition at line 169 of file MysqlConnection.cpp.

◆ drv_executeSql()

bool MysqlConnection::drv_executeSql ( const KDbEscapedString & sql )

overrideprotectedvirtual

Executes query for a raw SQL statement sql without returning resulting records.

It is useful mostly for INSERT queries but it is possible to execute SELECT queries when returned records can be ignored. The @sql should be is valid and properly escaped.

Note: Only use this method if you really need.

See also: executeSql

Implements KDbConnection.

Definition at line 186 of file MysqlConnection.cpp.

◆ drv_getDatabasesList()

bool MysqlConnection::drv_getDatabasesList ( QStringList * list )

overrideprotectedvirtual

For reimplementation: 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.

See also: databaseNames

Reimplemented from KDbConnection.

Definition at line 108 of file MysqlConnection.cpp.

◆ drv_getServerVersion()

bool MysqlConnection::drv_getServerVersion ( KDbServerVersionInfo * version )

overrideprotectedvirtual

For implementation: Sets version to real server's version. Depending on backend type this method is called after (if KDbDriverBehavior::USING_DATABASE_REQUIRED_TO_CONNECT is true) or before database is used (if KDbDriverBehavior::USING_DATABASE_REQUIRED_TO_CONNECT is false), i.e. for PostgreSQL it is called after. In any case it is called after successful drv_connect().

Returns: true on success.

Todo: this is hardcoded for now; define api for retrieving variables and use this API...

Implements KDbConnection.

Definition at line 67 of file MysqlConnection.cpp.

◆ drv_prepareSql()

KDbSqlResult * MysqlConnection::drv_prepareSql ( const KDbEscapedString & sql )

overrideprotectedvirtual

Prepares query for a raw SQL statement sql with possibility of returning records.

It is useful mostly for SELECT queries. While INSERT queries do not return records, the KDbSqlResult object offers KDbSqlResult::lastInsertRecordId(). The @sql should be is valid and properly escaped. Only use this method if you really need. For low-level access to the results (without cursors). The result may be not stored (not buffered) yet. Use KDbSqlResult::fetchRecord() to fetch each record.

Returns: Null pointer if there is no proper result or error. Ownership of the returned object is passed to the caller.

See also: prepareSql

Todo: use mysql_error()

Implements KDbConnection.

Definition at line 176 of file MysqlConnection.cpp.

◆ drv_useDatabase()

bool MysqlConnection::drv_useDatabase	(	const QString &	dbName = QString(),
		bool *	cancelled = nullptr,
		KDbMessageHandler *	msgHandler = nullptr )

overrideprotectedvirtual

For implementation: opens existing database using connection

Returns: true on success, false on failure; sets cancelled to true if this action has been cancelled.

Todo: is here escaping needed?

Implements KDbConnection.

Definition at line 150 of file MysqlConnection.cpp.

◆ prepareQuery() [1/2]

KDbCursor * MysqlConnection::prepareQuery	(	const KDbEscapedString &	sql,
		KDbCursor::Options	options = KDbCursor::Option::None )

overridevirtual

Prepares SELECT query described by a raw statement sql.

Returns: opened cursor created for results of this query or nullptr if there was any error. Ownership of the returned object is passed to the caller. KDbCursor can have optionally applied options (one of more selected from KDbCursor::Options). Preparation means that returned cursor is created but not opened. Open this when you would like to do it with KDbCursor::open().

Note for driver developers: you should initialize cursor engine-specific resources and return KDbCursor subclass' object (passing sql and options to its constructor).

Implements KDbConnection.

Definition at line 98 of file MysqlConnection.cpp.

◆ prepareQuery() [2/2]

KDbCursor * MysqlConnection::prepareQuery	(	KDbQuerySchema *	query,
		KDbCursor::Options	options = KDbCursor::Option::None )

overridevirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Prepares query described by query schema without parameters.

Implements KDbConnection.

Definition at line 103 of file MysqlConnection.cpp.

◆ prepareStatementInternal()

KDbPreparedStatementInterface * MysqlConnection::prepareStatementInternal ( )

overridevirtual

Prepare an SQL statement and return a KDbPreparedStatementInterface-derived object. Ownership of the returned object is passed to the caller.

Implements KDbConnection.

Definition at line 206 of file MysqlConnection.cpp.

◆ serverResultName()

QString MysqlConnection::serverResultName ( ) const

overrideprotectedvirtual

Implemented for KDbResultable.

Reimplemented from KDbResultable.

Definition at line 195 of file MysqlConnection.cpp.

◆ storeResult()

void MysqlConnection::storeResult ( )

protected

Definition at line 211 of file MysqlConnection.cpp.

Member Data Documentation

◆ d

MysqlConnectionInternal* const MysqlConnection::d

protected

Definition at line 75 of file MysqlConnection.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KDb

MysqlConnection

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~MysqlConnection()

◆ MysqlConnection()

Member Function Documentation

◆ drv_closeDatabase()

◆ drv_connect()

◆ drv_containsTable()

◆ drv_createDatabase()

◆ drv_databaseExists()

◆ drv_disconnect()

◆ drv_dropDatabase()

◆ drv_executeSql()

◆ drv_getDatabasesList()

◆ drv_getServerVersion()

◆ drv_prepareSql()

◆ drv_useDatabase()

◆ prepareQuery() [1/2]

◆ prepareQuery() [2/2]

◆ prepareStatementInternal()

◆ serverResultName()

◆ storeResult()

Member Data Documentation

◆ d