Skip to main content



Add an aggregator node to the cluster.


Add an aggregator node to the cluster

  memsqlctl add-aggregator [flags]

  -h, --help                             Help for add-aggregator
      --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)
      --role {follower, voting_member}   The role that an aggregator will be assigned when added.
                                         This option identifies whether the added aggregator will be a candidate for Master Aggregator failover.
                                         Possible roles are voting_member and follower. The default value is follower. (default follower)
      --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 SingleStoreDB 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 must be run from the same host that the master aggregator is currently running on.

  • After memsqlctl connects to the node specified by the user, it runs the query ADD AGGREGATOR user:password@host:port on the master aggregator.

  • --password is a required flag that specifies the SingleStoreDBroot password. You can optionally use this flag in conjunction with the --user flag to specify a SingleStoreDB 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-aggregator --port 3306 --password '<<fooismypassword'

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

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


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

$ sudo memsqlctl add-aggregator --host ""
memsqlctl will perform the following actions on the local master aggregator on port 3306:
  · Run `ADD AGGREGATOR root:****@`

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