Database object

Description

The database object contains information on current database set-up and basic methods to run SQL towards the database.

Methods

BeginTransaction()

Starts a new SQL transaction. Only affects ExecuteSQL().

CommitTransaction()

Commits a SQL transaction. Only affects ExecuteSQL().

CreateExternalDatabase(eDBtype ServerType, string ServerName, long lPort, string DatabaseName, string Username, string Password)

Create external database

CreateInternalDatabase()

Create internal database

ExecuteSQL(string sSQLStatement)

Executes an SQL statement.

ExecuteSQLScript(string sFilename)

Executes an script file containing SQL statements.

RollbackTransaction()

Rollbacks a SQL transaction. Only affects ExecuteSQL().

SetDefaultDatabase(eDBtype ServerType, string ServerName, long lPort, string DatabaseName, string Username, string Password)

Set default database

UtilGetFileNameByMessageID(long MessageID)

Returns the filename for a given message id.

Properties

long CurrentVersion

Current databaseversion.
(read-only)

bool DatabaseExists

Checks whether an existing database exists.
(read-only)

string DatabaseName

Database name.
(read-only)

eDBtype DatabaseType

The type of the database.
(read-only)

bool IsConnected

Returns true if there is a database available.
(read-only)

long RequiredVersion

Required database version.
(read-only)

bool RequiresUpgrade

Database needs to be upgraded.
(read-only)

string ServerName

Server name.
(read-only)

Search documentation