Executing Console Commands

5.5-SNAPSHOT 5.4 5.3 5.2 5.1 5.0 4.2022.01 4.2021.12 4.2021.12-1 4.2021.06 4.2021.04

The console feature allows you to execute client operations using the built-in Hazelcast Command-Line Client (CLC).

Management Center includes an interactive version of Hazelcast’s Command-Line Client (CLC). CLC functions as a client and adheres to any Security ACLs configured for it.

CLC supports a wide range of data structures and the ability to run SQL queries from a text terminal. It also provides flexible output options, such as table, CSV, and JSON formats.

For further information on these features, refer to the Overview topic of the CLC documentation.

The console is not recommended for production use.

Console is disabled by default, and you need to enable it in your cluster’s configuration. See Toggle Console Support for details. The member list shows whether the console is enabled or disabled for each member.

  1. Open a console window by clicking on the Console button located at the Side Bar.

    Console

  2. Execute any SQL query in the terminal. Do not prefix SQL queries.

    Console SQL

  3. Prefix CLC commands with \. For example, \atomic-long.

    Console Commands

To get help or a list of all possible commands, enter \help in the console. You can use the --help option with any command to view the help for that command.

The console container is resizable; to change the height, drag the bar on the top of the console. You can maximize or minimize the console container using the icons in its top-right corner.