Skip to main content

getDatabaseConnectionByID

Last updated 10/05/2023

The getDatabaseConnectionByID() establishes the connection to the external DatabaseManagement System (DBMS). It will return a handle to the database that may be inspected to check if the connection is successful or not using the isOK() function provided on the handle.


info

There is a special define on the Five object called SYSTEM_DATABASE_NAME which allows a connection to the system database so you can query the roles of the application if required.



Available
Server


Function Signature
getDatabaseConnectionByID(databaseID: string) : DatabaseConnection;


ParameterTypeDescription
DatabaseIDstringDatabaseID for the Database.

Examples

getDatabaseConnectionByID()