Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

connect

Connects to a cluster. This is a REPL-only command.

command specdescription
connect [--cluster-url]Create a session for the cluster, i.e. subsequent commands do not require the cluster URL anymore

disconnect

Disconnects the current session. This is a REPL-only command.

command specdescription
disconnectDisconnect the current session

sql

REPL mode

command specdescription
sql <query>

If executed without parameters, create a SQL connection session within the REPL. From this point, it provides functionality similar to a command-line JDBC tool (e.g., sqlline)  

non-REPL mode

command specdescription
ignite sql [--cluster-url][--script-file] <query>

Execute sql query and print the result

topology

According to the join protocol, we are going to have two types of node topologies: "physical" (a.k.a. network) topology and "logical" topology. It may be convenient for the user to know which nodes have passed validation and have joined the logical topology, therefore it is suggested to implement a CLI command for this purpose.

Response example:

consistent ID, ID, address, status

node 1, e2d4988a-b836-4e7e-a888-2639e6f79ef0, 127.0.0.1, RUNNING

node 2, 5cb561fc-1963-4f95-98f8-deb407669a86, 127.0.0.2, RECOVERY

REPL mode

command specdescription
topologyShow the topology of the connected cluster

non-REPL mode

command specdescription
ignite topology [--cluster-url]Show the topology of the cluster

version

REPL mode

command specaliasdescription
version
Show the version of the CLI Tool

non-REPL mode

command specaliasdescription
ignite versionignite --versionShow the version of the CLI Tool

cluster

cluster init

Initializes cluster in a way described in IEP-77.

REPL mode

command specdescription
cluster init [--cluster-url]<--meta-storage-node>[--cmg-node]<--cluster-name>

Initialize the connected cluster

non-REPL mode

command specdescription
ignite cluster init [--cluster-url]<--meta-storage-node>[--cmg-node]<--cluster-name>

Initialize the cluster

meta-storage-node is a list with a minimum 1 argument, cmg-node is a list but could be empty.

...