BroadSQL Download
On this page
Documentation / Commands / CONFIG

CONFIG

Core command

Opens the window that manages connections, Database Groups, Environments, login scripts and application settings (Windows only).

Syntax

CONFIG

Examples

CONFIG;

Details

Availability

CONFIG runs on Windows only; on another system it fails with an error. It works from any connection state: at BroadSQL> with no database connection, on an ordinary connection, or in CDF maintenance mode. The window reads and saves the BroadSQL configuration database (CDF) directly, through BroadSQL's configuration subsystem; it never uses or changes the current database connection, so connecting to the CDF is never needed to manage connections.

Tabs

  • Connections: a sortable table (Connection, Database Group, Environment, Status) with multiple selection, a search box filtering by connection, Database Group or Environment, and the form of the selected connection. Its "Login Scripts" tab manages the SQL statements run each time that connection opens.
  • Database Groups: the list of Database Groups offered in every connection's Database Group field.
  • Environments: the list of Environments, managed the same way. An Environment flagged Production makes BroadSQL ask for a confirmation before a statement that can modify a database of that Environment.
  • Application Settings: every setting of the INI file (BroadSQL.ini), with its value in the file, the value in use and a status (Default, In effect, Restart needed, Invalid in file, Read-only). The selected setting shows its description, accepted values, default and when a change applies. Apply holds a change in the window; Save writes the file, Revert drops the changes not saved, Reload reads the file again. An invalid value is refused and nothing is written while a value is in error. Saving rewrites only the values you changed and keeps the previous file as BroadSQL.ini.bak; a file changed by another program since it was read is not overwritten. Only ProductionConfirmEveryChange applies at once; every other change takes effect at the next start. ServersFileName is read-only. apiproxypassword is never displayed.

One menu bar (File: Exit; Edit: New, Save, Duplicate, Test, Deactivate, Reactivate, Delete permanently; View: Active, Inactive, All) acts on the selected tab; on Application Settings, only Save applies. The same actions are buttons below each tab's form. Closing the window with changes not saved asks whether to save them.

Active and inactive records

The three tabs share one life cycle, with a "Show:" switch for Active, Inactive and All.

  • An inactive connection, Database Group or Environment is greyed out and cannot be edited or saved: it can only be reactivated or deleted permanently, each after a confirmation. Several connections can be deactivated, reactivated or deleted permanently at once.
  • Deactivating never runs the checks of a save, so an obsolete connection whose Database Group and Environment no longer form a valid pair can still be deactivated without being corrected first.
  • A Database Group or an Environment can be deleted permanently only once it is inactive and no connection, active or inactive, uses it; the error names the connections that still use it.
  • Saving a new connection under the ID of an inactive one offers to reactivate that connection instead, with a warning that what was typed in the form is then discarded.

Database types

The Type list shows every recognized database type. A type whose JDBC driver is not found in drivers/ or lib/ is greyed out and marked "(driver not found)"; it can still be chosen, but the connection fails until the driver JAR is added.

Last modified in release 5.5.0.

← All commands

Found something wrong or unclear on this page? , with the page address.