A newer version of Hazelcast CLC is available.

View latest

clc

5.4.1 5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

Usage:

clc

Starts the interactive shell for running SQL queries and Hazelcast CLC commands.

The shell defaults to running SQL queries, which you can execute from a command prompt and get the result. The query should end with a semicolon:

> select * from cities;
---------------------------------------------------------------------------------
      __key | country                   | city                      | population
---------------------------------------------------------------------------------
          1 | United Kingdom            | London                    |    9540576
          5 | Turkey                    | Ankara                    |    5309690
          4 | United States             | Los Angeles               |    3985520
---------------------------------------------------------------------------------

In order to run Hazelcast CLC commands, prefix them with a backslash (\):

> \object list --show-hidden
-------------------------------------------------
 Service Name     | Object Name
-------------------------------------------------
 executor         | hot-backup-executor
 flakeidgenerator | __jet.ids
 map              | cities
 replicatedmap    | __sql.catalog
-------------------------------------------------

You can enter multiline commands by ending all lines except the last line with a backslash (\):

> \object list \
 ... --show-hidden
-------------------------------------------------
 Service Name     | Object Name
-------------------------------------------------
 executor         | hot-backup-executor
 flakeidgenerator | __jet.ids
 map              | cities
 replicatedmap    | __sql.catalog
-------------------------------------------------

Shortcut Commands

exit

Exits the shell.

Usage:

exit

help

Display help for CLC commands

Usage:

help

di

Lists indexes. If you provide a mapping, it lists indexes to that specific mapping, otherwise it lists all the indexes.

Usage:

di [MAPPING]

Parameters:

Parameter Required Description Default

MAPPING

Optional

Name of the mapping.

dm(+)

If you don’t provide the MAPPING parameter, it lists mappings. If you add + postfix, it describes the given mapping, otherwise it displays information about it.

Usage:

dm(+) [MAPPING]

Parameters:

Parameter Required Description Default

MAPPING

Optional

Name of the mapping.
lifebuoy

Help and support