Disables connections to a tenant database.
CALL DBCloud.DisableConnections ( database=database [, optional-parameters ] )
dbcloudcmd run DisableConnections database [ optional-parameters ]
The database to disable connections to. Accepts a search query that identifies databases. (Required)
Set to 1 to indicate that all existing connections should be dropped. The default is 1.
This task disables connections to the primary database or read-write database until the database is restarted or connections are re-enabled with the EnableConnections task or the database is restarted.
If the drop_connections parameter is set to 1, then existing connections from client applications are dropped.
Prior to running this task, consider notifying users whose connections might be affected.
This task can be run without error if connections are already disabled.
Connections from client applications are disabled, but DisableConnections does not disable any connections present as a result of running the ExecuteTenantBatch task.
Run the following task to disable connections to the database mydatabase:
dbcloudcmd run DisableConnections database=mydatabase
Run the following task to disable connections to all tenant databases with the tag mytag:
dbcloudcmd run DisableConnections database=tag:mytag