Skip to main content
Version: 8.1

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 NameDescription
NameReturns the name of this datasource.
DescriptionReturns the description for this datasource.
DBTypeReturns the database connection type. Example types include PostgreSQL, MSSQL, and Oracle.
StatusReturns the status of this datasource based on its last tested condition. Typical values include Valid, Faulted, and Reconnecting.
ProblemReturns a string describing the current problem, if the status is not good.
ExtStatusReturns the "best" status of this datasource or of any failover datasources.
ThroughputReturns number of queries per second, including Insert and Select queries. Throughput will be -1 if idle.
ActiveConnectionsReturns the current number of connections in use.
MaxConnectionsReturns the maximum number of connections the underlying pool is configured to use.
ValidationQueryReturns 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.

Keywords

system db getConnections, db.getConnections