system.db.getConnections
This function is used in Python Scripting.
Description​
Returns a dataset of information about each configured database connection. Each row represents a single connection.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.db.getConnections()
Parameters​
None
Returns​
Dataset - A dataset, where each row represents a database connection.The dataset contains the following:
| Column Name | Description |
|---|---|
| Name | Returns the name of this datasource. |
| Description | Returns the description for this datasource. |
| DBType | Returns the database connection type. Example types include PostgreSQL, MSSQL, and Oracle. |
| Status | Returns the status of this datasource based on its last tested condition. Typical values include Valid, Faulted, and Reconnecting. |
| Problem | Returns a string describing the current problem, if the status is not good. |
| ExtStatus | Returns the "best" status of this datasource or of any failover datasources. |
| Throughput | Returns number of queries per second, including Insert and Select queries. Throughput will be -1 if idle. |
| ActiveConnections | Returns the current number of connections in use. |
| MaxConnections | Returns the maximum number of connections the underlying pool is configured to use. |
| ValidationQuery | Returns a SQL query that will be used to validate the status of this datasource. This query should always return at least 1 row. |
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
There are no code examples available for this function.