BroadSQL Download
On this page
Documentation / Commands / LOGOUT

LOGOUT

Core command LOGOFF

Ends the authenticated session: closes every connection and asks for the master password again.

Syntax

LOGOUT

Quick start

LOGOUT;

Closes every connection; type the master password to continue at BroadSQL>.

Examples

LOGOUT;
LOGOFF;

Details

What LOGOUT does

LOGOUT (or LOGOFF) ends the authenticated BroadSQL session without leaving BroadSQL:

  • a running Editor Run is cancelled, and the BroadSQL Editor and the CONFIG windows are closed (unsaved Scripts are offered for saving first);
  • every database connection is closed, the CDF maintenance connection included: pending work is rolled back, with a warning, unless autocommit is on;
  • the connection history, the remembered last connection, the API context, the API session variables, the Script variables and the last result are forgotten, and so are the master password and the decrypted connection definitions BroadSQL held in memory;
  • the master password is asked for again. Until it is typed, no command runs; after it, BroadSQL is at BroadSQL>, not connected to any database, even with RememberLastConnection=TRUE.

Three wrong passwords in a row, or the end of the input, end BroadSQL. Work started before the logout (an Editor Run) can no longer use the database, even after the password is typed again; anything that did not stop in time is reported.

LOGOUT, DISCONNECT and EXIT

DISCONNECT closes the current database connection and keeps you authenticated. LOGOUT closes every connection and asks for the master password again. EXIT ends BroadSQL.

Where it can be used

Typed at the BroadSQL prompt only: it is refused in a Script, a REPEAT and an Editor Run.

Memory

BroadSQL drops every reference it holds to the master password and the decrypted definitions. Java does not allow erasing text in memory: the values stay in the process memory until it is reused.

Last modified in release development.

← All commands

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