describe-node
Warning
SingleStore 9.0 gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.
On this page
Description
Get a property of a node on the host.
The following describes the properties of a SingleStore node.
Name |
Description |
---|---|
|
GUID value uniquely identifying this node. |
|
Role of the node in the cluster. |
|
Port number that this node is listening on. |
|
The IP address that the node is listening on. |
|
Whether to enable IPv6 support. |
|
Current state of |
|
Version of SingleStore for this node. |
|
Absolute path of the Defined in the Refer to SingleStore Node Config Files for more information. |
|
Directory path for the data directory. |
|
Directory path for the plancache directory. Default value: |
|
Directory path for the tracelogs directory. Default value: |
|
Specifies the local or network directory to write log files. Default value: |
|
Absolute path of |
|
A unique identifier used to distinguish each node. |
|
Process ID for the |
|
Process ID for the |
|
Indicates whether a node is configured to restart automatically if it should stop unexpectedly. |
|
Specifies if |
|
An enum describing whether or not the node’s databases are recovering. |
|
Availability group that the leaf node belongs to for high availability. |
|
The role assigned to an aggregator node within the cluster. |
Usage
Usage:
memsqlctl describe-node [flags]
Flags:
-h, --help Help for describe-node
--memsql-id string the node ID of the node to describe
--property {MemsqlID, Role, AggregatorRole, ProcessState, Version, Memsqld, MemsqlConfig,
Port, BindAddress, AllowIpv6, Datadir, Tracelogsdir, Plancachedir, Auditlogsdir,
IsConnectable, Pid, DPid, AutoRestartEnabled, RecoveryState, AvailabilityGroup,
Host, NodeID, Config[.${CONFIG_NAME}], Variables[.${VARIABLE_NAME}]}
Only output the value of this property (default Unspecified)
Global Flags:
-c, --config FILE_PATH Path to the memsqctl config file
--default-install-dir DIRECTORY_PATH Path to the default install directory
--insecure-ssl Fall back to insecure SSL connections to local nodes if memsqlctl is unable to otherwise establish a connection (ADVANCED)
-j, --json Print output in JSON format
--node-metadata-file FILE_PATH Path to the node metadata file
--parallelism POSITIVE_INTEGER Maximum amount of operations to be run in parallel
--ssl-ca FILE_PATH The path to the CA certificate file (in PEM format) to authenticate the database certificate
--timeout duration Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
--verbose-json Print output in JSON format, include some warnings and user messages
-v, --verbosity count Increase logging verbosity
-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default
Remarks
-
This command is interactive unless you pass in a value for
--memsql-id
and enable non-interactive mode through the flag--yes
. -
The
memsqlctl describe-node
command is equivalent to the sdb-admin describe-node command.
Output
The following is the standard output for the describe-node
command.
sudo memsqlctl describe-node
+-------+------------+------------+------+---------------+---------+
| Index | MemSQL ID | Role | Port | Process State | Version |
+-------+------------+------------+------+---------------+---------+
| 1 | 994274A024 | Leaf | 3307 | Running | 6.5.10 |
| 2 | E289BBDF58 | Aggregator | 3306 | Running | 6.5.10 |
+-------+------------+------------+------+---------------+---------+
Select an option: 2
+-------------------+-----------------------------------------------------------------+
| memsqlId | E289BBDF587D96F323CFDBC190DA5A602C170E0A |
| role | Aggregator |
| port | 3306 |
| bindAddress | 0.0.0.0 |
| processState | Running |
| version | 6.5.10 |
| memsqlConfig | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/memsql.cnf |
| dataDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/data |
| plancacheDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/plancache |
| tracelogsDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/tracelogs |
| auditlogsDir | /var/lib/memsql/e56f2e26-cb6d-4b3c-a792-01a26bd6c3a0/auditlogs |
| memsqld | /opt/singlestoredb-server-7.3.10_6c220bccfc/memsqld |
| pid | 5745 |
| dpid | 5751 |
| isConnectable | true |
| recoveryState | Online |
| availabilityGroup | -- |
+-------------------+-----------------------------------------------------------------+
This example retrieves a single property value as JSON.
sudo memsqlctl describe-node --property "processState" --json
{
"processState": "Running"
}
Last modified: August 22, 2024