Add a leaf node to the cluster.

This command must be run from the same host that the Master Aggregator is currently running on.

If --availability-group is specified, memsqlctl will verify via the Master Aggregator that high availability (HA) is enabled. It will then run the query ADD LEAF user:password@host:port [INTO GROUP {1|2}] on the Master Aggregator.

The --password flag is equired and specifies the SingleStore root password. You can use this flag in conjunction with the --user flag to specify a SingleStore user that is different from the root user and the user’s password.

Note that the MEMSQL_PASSWORD environment variable is a safer alternative option for setting the password.

Wrap the password in single quotes (') to avoid having special characters included in the password interpreted by the shell. For example: sdb-admin add-leaf --port 3306 --password '<<fooismypassword'


memsqlctl add-leaf [flags]
--availability-group int The availability group to assign the node
-h, --help Help for add-leaf
--host string The cluster-addressable hostname for the node
-p, --password STRING The database user's password
--port PORT The cluster-addressable port for the node (default 3306)
--user string The database user (default "root")
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


  • This command is interactive unless you use either --yes or --json flag to override interactive behavior.

  • The memsqlctl add-leaf command is equivalent to the sdb-admin add-leaf command.


The following is the standard output for the add-leaf command.

sudo memsqlctl add-leaf --host ""
memsqlctl will perform the following actions on the local master aggregator on port 3306:
  · Run `ADD LEAF root:@ INTO GROUP 1`

Would you like to continue? [y/N]: y
✓ Added leaf to cluster

Last modified: April 22, 2024

Was this article helpful?