Skip to main content
Version: 8.1

system.db.setDatasourceEnabled

This function is used in Python Scripting.

Description

Enables/disables a given database connection.

Client Permission Restrictions

Permission Type: Datasource Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.db.setDatasourceEnabled(name, enabled)

Parameters

TypeParameterDescription
StringnameThe name of the database connection in Ignition.
BooleanenabledEnables/disables a given database connection.

Returns

Nothing

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet - Enabling a Database Connection
# Enable the database named "MySQL"

system.db.setDatasourceEnabled("MySQL", 1)
Code Snippet - Disabling a Database Connection
# Disable the database named "MySQL"

system.db.setDatasourceEnabled("MySQL", 0)

Keywords

system db setDatasourceEnabled, db.setDatasourceEnabled