[TITLE]
DG Broker Commands for SQLcl

[PURPOSE]
Document the Data Guard Broker (DG) commands supported by SQLcl, and describe how SQLcl executes DG Broker commands that are otherwise documented for DGMGRL.

[SCOPE]
- Applies to SQLcl version
- Applies to Oracle Data Guard Broker commands invoked through SQLcl
- Covers command availability and example usage
- Does NOT redefine command semantics already documented in DGMGRL documentation

[BACKGROUND]
Oracle SQLcl provides a DG command interface that allows users to execute Data Guard Broker commands directly from SQLcl.
These commands correspond to DGMGRL commands, but SQLcl documentation does not currently provide detailed usage descriptions.

For detailed command semantics, users should refer to the official Oracle Data Guard Broker documentation.

[REFERENCE_DOCUMENTATION]
Oracle Data Guard Broker Commands Reference:
https://docs.oracle.com/en/database/oracle/oracle-database/23/dgbkr/oracle-data-guard-broker-commands.html#GUID-AC5DA9D2-5E60-4484-9099-0388BF238ACA

[COMMAND_ENTRY_POINT]
DG commands are invoked in SQLcl using the following syntax. They should be executed using tool sqlcl_run.

DG <command>

[SUPPORTED_COMMANDS]
The following DG Broker commands(SHOW) are supported in SQLcl.

DG SHOW CONFIGURATION [ <property name> ];

DG SHOW CONFIGURATION VERBOSE [ <property name> ];

DG SHOW DATABASE <database name> [ <property name> ];

DG SHOW DATABASE VERBOSE <database name> [ <property name> ];

[USAGE_NOTE]
SQLcl does not redefine DG Broker command behavior.
Execution semantics, validations, and error handling match those of DGMGRL unless otherwise noted.

[NOTES]
- SQLcl DG commands provide a non-interactive alternative to DGMGRL.
- SQLcl DG commands are suitable for scripting and automation.
- Output formatting may differ slightly from DGMGRL output but conveys equivalent information.

[APPLICABILITY]
- SQLcl
- Oracle Database: Data Guard Broker enabled databases

[LIMITATIONS]
- Advanced interactive DGMGRL features are not available in SQLcl.
- SQLcl relies on underlying Data Guard Broker availability and configuration.

[OWNER]
Data Guard Team

[LAST_VERIFIED]
2026-02
