SingleStore DB

describe-node

Get a property of a MemSQL Node on the local machine.

Usage

You can retrieve help for the command by typing <application> [command] --help in the command line.

Remarks

This command is interactive unless you pass in a value for --memsql-id and enable non-interactive mode through the flag --yes.

The following describes the properties of a SingleStore node.

Name

Description

memsqlId

GUID value uniquely identifying this node.

role

Role of the node in the cluster. Valid values are Master, Aggregator (for child aggregators), Leaf, and Unknown.

port

Port number that this node is listening on.

bindAddress

The IP address that the node is listening on. A value of 0.0.0.0 means the node is listening on all available network interfaces on the host.

processState

Current state of memsqld for this node. Valid values are Running, Stopped, and Unknown.

version

Version of SingleStore DB for this node.

memsqlConfig

Absolute path of the memsql.cnf configuration file for SingleStore DB for this node.

dataDir

Absolute path of the data directory for SingleStore DB for this node.

plancacheDir

Absolute path of the plancache directory for SingleStore DB for this node.

tracelogsDir

Absolute path of the tracelogs directory for SingleStore DB for this node.

auditlogsDir

Absolute path of the auditlogs directory for SingleStore DB for this node.

memsqld

Absolute path of memsqld for this node.

pid

Process ID for the memsqld_safe process corresponding to this node.

dpid

Process ID for the memsqld process corresponding to this node.

isConnectable

Specifies if memsqlctl can connect to the node.

recoveryState

An enum describing whether or not the node’s databases are recovering. Values are Online, Recovering, and RecoveryFailed.

availabilityGroup

Availability group that the node belongs to.

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"
}