system.mongodb.listConnectorInfo

New in 8.1.28

This function is used in Python Scripting.

note

Project Library scripts will not provide hints for MongoDB system functions unless the Script Hint Scope is set to Gateway. See the Scripting in Ignition page for more details on scripting hints.

Description

Returns a list of PyDictionary descriptors of all MongoDB Connectors.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.mongodb.listConnectorInfo()

Parameters

Nothing

Returns

List[PyDictionary] connectors - A list of PyDictionaries containing MongoDB Connector descriptors. Descriptor contains keys for ‘name’, ‘description’, ‘status’, and ‘error’ (if present).

Scope

Gateway, Perspective Session

Code Examples

Example #1

# Retrieve and print the returned list of connectors found.
connectors = system.mongodb.listConnectorInfo()
 
print connectors[0]['name']
print connectors[0]['status']
print connectors[0]['description']
print connectors[0]['error']