class DBEngine
|
Entry point for the library. More... |
|
|
Public Methods
- virtual ~DBEngine ()
- PluginIterator beginPlugins ()
- Plugin * findPlugin (const QString &name)
- QStringList pluginNames ()
- Connection * openConnection (const QString &pluginName, const QString &host, int port, const QString &user, const QString &password = QString::null)
- Connection * openConnection (const QString &name)
- virtual Connection * addConnection (const QString &pluginName, const QString &host, int port = 0, const QString &user = QString::null, const QString &password = QString::null)
- void remove (Connection *)
- Connection * findConnection (const QString &plugin, const QString &host, const int port, const QString &user)
- Connection * findConnection (const QString &name)
- ConnectionIterator beginConnections ()
- void loadConnections (KConfigBase *config = 0L)
- void saveConnections (KConfigBase *config = 0L)
- Database * openDatabase (const QString &pluginName, const QString &host, int port, const QString &user, const QString &password, const QString &databaseName)
- KConfigBase * config ()
- void setConfig (KConfigBase* config)
- bool loadPlugin (const QString&)
- explicit DBEngine ()
Signals
Public Static Methods
- static DBEngine * self ()
Protected Methods
- virtual ~DBEngine ()
- PluginIterator beginPlugins ()
- Plugin * findPlugin (const QString &name)
- QStringList pluginNames ()
- Connection * openConnection (const QString &pluginName, const QString &host, int port, const QString &user, const QString &password = QString::null)
- Connection * openConnection (const QString &name)
- virtual Connection * addConnection (const QString &pluginName, const QString &host, int port = 0, const QString &user = QString::null, const QString &password = QString::null)
- void remove (Connection *)
- Connection * findConnection (const QString &plugin, const QString &host, const int port, const QString &user)
- Connection * findConnection (const QString &name)
- ConnectionIterator beginConnections ()
- void loadConnections (KConfigBase *config = 0L)
- void saveConnections (KConfigBase *config = 0L)
- Database * openDatabase (const QString &pluginName, const QString &host, int port, const QString &user, const QString &password, const QString &databaseName)
- KConfigBase * config ()
- void setConfig (KConfigBase* config)
- bool loadPlugin (const QString&)
- explicit DBEngine ()
Protected Slots
Entry point for the library.
This object manages all available plugins, and can create connections to
servers or databases.
In more detail:
- On first reference, loads all plugins registered in $KDEDIR/share/services.
- Allows iterations through all available plugins.
- Provide functions to directly access connections and databases through openDatabase
and openConnection
[virtual]
[static]
creates, if needed, the engine object, and returns it
PluginIterator beginPlugins ()
|
Returns an iterator that points to the first plugin.
Plugin * findPlugin (const QString &name)
|
Find a plugin by name. If no plugin is found, OL is returned.
QStringList 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)
|
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)
|
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)
|
[virtual]
Creates a connection object, without acually opening it
void remove (Connection *)
|
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)
|
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)
|
return a connection with the specified name
ConnectionIterator beginConnections ()
|
Returns an iterator that points to the first Connection
object.
Load all connections saved in the KConfig-object config.
If config is 0L the connections will be load from the
standard file kdbrc.
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)
|
Open a database. This is a convenience function.
retrieves the engine config object. this is either the general kde-db config
file kdbrc or a user supplied one, set using setConfig()
sets the config file for the current session.
any unsaved change to the previous config file will be lost
[signal]
[signal]
bool loadPlugin (const QString&)
|
[ protected:
]
Loads a plugin by its name if it is not already loaded.
[ protected slots:
slot]
- Version: kdbcore 0.0.2
- Author: Alessandro Praduroux <pradu@thekompany.com>
- Generated: marc@yogi on Tue Mar 27 13:09:39 2001, using kdoc 2.0a48.