Skip to main content

getDatabaseConnectionByID()

Last updated 11/09/2024

The

getDatabaseConnectionByID()
is a function on the
Five
object that establishes the connection to an external Database Management System (DBMS). It will return a handle to the database that may be inspected to check if the connection is successful or not using
isOk()
provided on the handle.

Available

Server

Function Signature
getDatabaseConnectionByID(databaseID: string) : DatabaseConnection;

ParameterTypeDescription
databaseID
stringDatabase ID for the database

Return Value

Returns a

DatabaseConnection
object.

Examples

getDatabaseConnectionByID()