You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

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

String name - The 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

Gateway, Vision Client, Perspective Session

The database connection used when called from the Gateway scope is the connection configured on the Gateway scripting project

Code Examples
Code Snippet - Getting Database Connection Information
# 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"



Keywords

system db getConnectionInfo, db.getConnectionInfo

  • No labels