THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Page History
...
connect
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 |
disconnect
Disconnects the current session. This is a REPL-only command.
| command spec | description |
|---|---|
disconnect | Disconnect the current session |
sql
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 |
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
topologynon-REPL mode
ignite topology [--cluster-url]version
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 |
cluster
cluster init
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.
...
Has to be rendered in HOCON format.
REPL mode
| command spec | description |
|---|---|
cluster config show [--cluster-url][--selector] | Show connected cluster configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster config show [--cluster-url][--selector] | Show connected cluster configuration |
cluster config update
REPL mode
| command spec | description |
|---|---|
cluster config update [--cluster-url] <config in HOCON format or path to file> | Update the connected cluster configuration with provided HOCON configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster config update [--cluster-url] <config in HOCON format or path to file> | Update the cluster configuration with provided HOCON configuration |
cluster topology physical
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
node 2, 5cb561fc-1963-4f95-98f8-deb407669a86, 127.0.0.2
REPL mode
| command spec | description |
|---|---|
cluster topology physical | Show the physical topology of the connected cluster |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster topology physical [--cluster-url] | Show the physical topology of the cluster |
cluster topology logical
REPL mode
| command spec | description |
|---|---|
cluster topology logical | Show the logical topology of the connected cluster |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster topology logical [--cluster-url] | Show the logical topology of the cluster |
node
node start
Start the Ignite 3 node.
REPL mode
| command spec | description |
|---|---|
node start [--config] <nodeName> | Start node with the default configuration or reads the config from --config option |
non-REPL mode
| command spec | description |
|---|---|
ignite node start [--config] <nodeName> | Start node with the default configuration or reads the config from --config option |
node stop
Stop the Ignite 3 node.
REPL mode
| command spec | description |
|---|---|
node stop <nodeName> | Stop node |
non-REPL mode
| command spec | description |
|---|---|
ignite node stop <nodeName> | Stop node |
node status
Shows the status of the node. Could be starting, started, stopping, and recovering.
REPL mode
| command spec | description |
|---|---|
node status [--node-url] | Shows the node status |
non-REPL mode
| command spec | description |
|---|---|
ignite node status [--node-url] | Shows the node status |
node config show
Has to be rendered in HOCON format.
REPL mode
| command spec | description |
|---|---|
node config show [--node-url][--selector] | Read the local node configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite node config show [--node-url][--selector] | Read the local node configuration |
node config update
REPL mode
| command spec | description |
|---|---|
node config update [--node-url] <config in HOCON format or path to file> | Update the connected local node configuration with provided HOCON configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite node config update [--node-url] <config in HOCON format or path to file> | Update the local node configuration with provided HOCON configuration |
node list
REPL mode
| command spec | description |
|---|---|
node list | Show the list of nodes running locally |
non-REPL mode
| command spec | description |
|---|---|
ignite node list | Show the list of nodes running locally |
cli config
cli config get
REPL mode
| command spec | alias | description |
|---|---|---|
cli config get <config key> [--profile-name -p] | cli configs (~ default get without parameters) | Show the default config value for the CLI Tool. Displays all default configs if called without parameter. Show property of profile with provided name. |
non-REPL mode
| command spec | alias | description |
|---|---|---|
ignite cli config get <config key> [--profile-name -p] | ignite cli configs | Show the default config value for the CLI Tool. Displays all default configs if called without parameter. Show config value of profile with provided name. |
cli config set
REPL mode
| command spec | description |
|---|---|
cli config set <config key-value> [--profile-name -p] | Set the default config value for the CLI Tool. Set the config value for profile with provided name. |
non-REPL mode
| command spec | description |
|---|---|
ignite cli config set <config key-value> [--profile-name -p] | Set the default config value for the CLI Tool. Set the config value for profile with provided name. |
cli config profile
...
Overview
Content Tools
Apps