Motivation

TBD

Description

TBD

Command list

Ignite 3 CLI tool is a command-line utility that acts as an entry point for all monitoring and management operations with Apache Ignite clusters. A user should download the tool from the website and then use it to:

• Connect to a cluster to monitor its state and perform management operations (configuration changes, cluster init).
• Connect to a cluster to run SQL queries.
• Connect to a cluster to get the cluster status (topology, version).

Description

The tool should be designed and developed with an explicit focus on usability and respect for https://clig.dev/#guidelines. In addition to regular commands, it should feature a fully-fledged REPL for different functions. REPL mode must provide the following capabilities:

• Advanced completion.
• Command history.
• Current status.

REPL mode is used by default and is activated if the ignite command is executed without parameters.

Communication with the cluster 

The tool should connect to a remote cluster via the REST endpoints provided by the cluster. REST client can be generated from Open API specification (see IEP-87). For SQL REPL mode the JDBC is used.

Command list

Help

Help must be available for every command and should include at least the following:

• Description of the command (what it does and when it should be used).
• The general syntax of the command.
• List of available parameters with their names and descriptions.
• Typical usage examples for the command in general, and for specific parameters where appropriate.

REPL mode

non-REPL mode

Open tickets

TBD

Closed tickets

TBD