THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Page History
...
cluster config show
Has to be rendered in HOCON format.
REPL mode
| command spec | description |
|---|---|
cluster config show [--cluster-url][--selector] | Read the connected cluster configuration |
non-REPL mode
| command spec | description |
|---|---|
ignite cluster config show [--cluster-url][--selector] | Read the 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 |
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 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 |
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 |
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 |
cli config get
REPL mode
| command spec | alias | description |
|---|---|---|
cli config get <config key> | cli configs (~ default get without parameters) | Show the default config value for the CLI Tool. Displays all default configs if called without parameter |
non-REPL mode
| command spec | alias | description |
|---|---|---|
ignite cli config get <config key> | ignite cli configs | Show the default config value for the CLI Tool. Displays all default configs if called without parameter |
cli config set
REPL mode
| command spec | description |
|---|---|
cli config set <config key-value> | Set the default config value for the CLI Tool |
non-REPL mode
| command spec | description |
|---|---|
ignite cli config set <config key-value> | Set the default config value for the CLI Tool |
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 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 |
...
Overview
Content Tools
Apps