Skip to main content
Version: 7.9

system.db.getConnectionInfo

This function is used in Python Scripting.

Description​

Returns a dataset of information about a single database connection, as specified by the name argument.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.db.getConnectionInfo(name)

Parameters​

TypeParameterDescription
StringnameThe name of the database connection to find information about.

Returns​

Dataset - A dataset containing information about the named database connection, or an empty dataset if the connection wasn't found.

Scope​

All

Code Examples​

Example #1
# This example checks the database connection type and selects a query format that matches.
  
connectionInfo = system.db.getConnectionInfo()
dbType = connectionInfo.getValueAt(0, "DBType")
if dbType == "MYSQL":
    # mysql format for a column with a space in the name
    query = "SELECT `amps value` FROM pumps"
else:
    # mssql format for a column with a space in the name
    query = "SELECT [amps value] FROM pumps"