SingleStore DB


Add a leaf node to the MemSQL cluster.

Add a leaf node to the MemSQL cluster

  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 user's password for connecting to MemSQL
      --port PORT                The cluster-addressable port for the node (default 3306)
      --user string              The MemSQL 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 SingleStore DB 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                     Path to the CA certificate file in PEM format to authenticate the MemSQL server 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 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 is enabled. It will then run the query ADD LEAF user:password@host:port [INTO GROUP {1|2}] on the master aggregator.

  • --password is a required flag that specifies the SingleStore DB root password. You can optionally use this flag in conjunction with the --user flag to specify a SingleStore DB 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.

  • 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