|
|
Entry point for the library.
This object manages all available plugins, and can create connections to servers or databases.
In more detail:
~DBEngine ()
| ~DBEngine |
[virtual]
DBEngine * self ()
| self |
[static]
creates, if needed, the engine object, and returns it
PluginIterator beginPlugins ()
| beginPlugins |
Returns an iterator that points to the first plugin.
Plugin * findPlugin (const QString &name)
| findPlugin |
Find a plugin by name. If no plugin is found, OL is returned.
QStringList pluginNames ()
| pluginNames |
Returns the names of all detected plugins
Connection * openConnection (const QString &pluginName, const QString &host, int port,
const QString &user, const QString &password = QString::null)
| openConnection |
Open a connection to the given host, with the given plugin, username and password. If the plugin does not exists, OL is returned. This is a convenience function, to avoid passing through a plugin to get a connection
Connection * openConnection (const QString &name)
| openConnection |
open a connection by name. If there is no such connection, 0L is returned. This differs from the other openConnection call, that builds one on the fly
Connection * addConnection (const QString &pluginName,
const QString &host,
int port = 0,
const QString &user = QString::null,
const QString &password = QString::null)
| addConnection |
[virtual]
Creates a connection object, without acually opening it
void remove (Connection *)
| remove |
Removes a connection from the list of connections. This will delete the connection, so make sure to not have dangling reference to the connection.
Connection * findConnection (const QString &plugin,
const QString &host,
const int port,
const QString &user)
| findConnection |
Return a connection to the specified host for the given user. If the returned value is 0L no connection with the specified arguments is found.
Connection * findConnection (const QString &name)
| findConnection |
return a connection with the specified name
ConnectionIterator beginConnections ()
| beginConnections |
Returns an iterator that points to the first Connection object.
void loadConnections (KConfigBase *config = 0L)
| loadConnections |
Load all connections saved in the KConfig-object config. If config is 0L the connections will be load from the standard file kdbrc.
void saveConnections (KConfigBase *config = 0L)
| saveConnections |
Save all connections to the KConfig-object config. If config is 0L the connections will be saved into the standard file kdbrc.
Database * openDatabase (const QString &pluginName, const QString &host, int port,
const QString &user, const QString &password,
const QString &databaseName)
| openDatabase |
Open a database. This is a convenience function.
KConfigBase * config ()
| config |
retrieves the engine config object. this is either the general kde-db config file kdbrc or a user supplied one, set using setConfig()
void setConfig (KConfigBase* config)
| setConfig |
sets the config file for the current session. any unsaved change to the previous config file will be lost
void connectionAdded (KDB::Connection *)
| connectionAdded |
[signal]
void connectionRemoved (KDB::Connection *)
| connectionRemoved |
[signal]
bool loadPlugin (const QString&)
| loadPlugin |
[protected]
Loads a plugin by its name if it is not already loaded.
void slotConnectionClosed (KDB::Connection *)
| slotConnectionClosed |
[protected slots slot]