PLDatabase::Database Class Reference

Abstract SQL (Structured Query Language) database base class. More...

#include <Database.h>

Inheritance diagram for PLDatabase::Database:

List of all members.

Public Member Functions
virtual PLDATABASE_API	~Database ()
	Creates a database instance.
virtual PLCore::String	GetVersion () const =0
	Returns the version of the database implementation.
virtual bool	Connect (const PLCore::String &sServer, const PLCore::String &sUserName, const PLCore::String &sUserPassword, const PLCore::String &sDatabase)=0
	Connect to a database.
virtual bool	IsConnected () const =0
	Returns whether there's an active database connection or not.
virtual bool	IsConnectionActive () const =0
	Returns whether the connection to the database is still active or not.
virtual bool	Disconnect ()=0
	Disconnect from the database.
virtual DatabaseQuery *	CreateQuery ()=0
	Creates a database query.
Protected Member Functions
PLDATABASE_API	Database ()
	Constructor.

---

Detailed Description

Abstract SQL (Structured Query Language) database base class.

---

Constructor & Destructor Documentation

virtual PLDATABASE_API PLDatabase::Database::~Database

(

)

[virtual]

Creates a database instance.

Parameters:

[in]

sClass

Class name of the database implementation

Returns:

The database instance, a null pointer on error

Destructor

PLDATABASE_API PLDatabase::Database::Database

(

)

[protected]

Constructor.

---

Member Function Documentation

virtual PLCore::String PLDatabase::Database::GetVersion

(

)

const [pure virtual]

Returns the version of the database implementation.

Returns:

The version of the database implementation

virtual bool PLDatabase::Database::Connect	(	const PLCore::String &	sServer,
		const PLCore::String &	sUserName,
		const PLCore::String &	sUserPassword,
		const PLCore::String &	sDatabase
	)		[pure virtual]

Connect to a database.

Parameters:

[in]	sServer	Server name, can be a hostname (for instance 'localhost') or a IP-address
[in]	sUserName	User name
[in]	sUserPassword	User password
[in]	sDatabase	Database

Returns:

'true' if all went fine, else 'false'

virtual bool PLDatabase::Database::IsConnected

(

)

const [pure virtual]

Returns whether there's an active database connection or not.

Returns:

'true' if there's an active database connection, else 'false'

virtual bool PLDatabase::Database::IsConnectionActive

(

)

const [pure virtual]

Returns whether the connection to the database is still active or not.

Returns:

'true' the connection to the database is still active, else 'false'

Remarks:

Checks whether the server connection is still active. If the connection has broken, normally an automatic reconnection is attempted. If you as client idle for a long tíme, you can use this function to check whether the server has closed the connection and reconnect if necessary.

virtual bool PLDatabase::Database::Disconnect

(

)

[pure virtual]

Disconnect from the database.

Returns:

'true' if all went fine, else 'false' (maybe there's no connection to disconnect?)

virtual DatabaseQuery* PLDatabase::Database::CreateQuery

(

)

[pure virtual]

Creates a database query.

Returns:

The database query, a null pointer on error

---

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

• Database.h