...
Connects to a cluster. This is a REPL-only command.
command spec | description |
---|---|
connect [--cluster-url] | Create a session for the cluster, i.e. subsequent commands do not require the cluster URL anymore |
Disconnects the current session. This is a REPL-only command.
command spec | description |
---|---|
disconnect | Disconnect the current session |
REPL mode
command spec | description |
---|---|
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 spec | description |
---|---|
ignite sql [--cluster-url][--script-file] <query> | Execute sql query and print the result |
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 spec | description |
---|---|
topology | Show the topology of the connected cluster |
non-REPL mode
command spec | description |
---|---|
ignite topology [--cluster-url] | Show the topology of the cluster |
REPL mode
command spec | alias | description |
---|---|---|
version | Show the version of the CLI Tool |
non-REPL mode
command spec | alias | description |
---|---|---|
ignite version | ignite --version | Show the version of the CLI Tool |
Initializes cluster in a way described in IEP-77.
REPL mode
command spec | description |
---|---|
cluster init [--cluster-url]<--meta-storage-node>[--cmg-node]<--cluster-name> | Initialize the connected cluster |
non-REPL mode
command spec | description |
---|---|
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.
...