add-aggregator
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
Add the node as a child aggregator to the cluster.
This command will add the specified node as a child aggregator and must be run on the Master Aggregator.
A cluster node can be specified by using the --memsql-id
flag.
When using this command, you should use --memsql-id
rather than --host
and/or --port
.
The --password
flag is required and specifies the SingleStoreroot
password.--user
flag to specify a SingleStore user that is different from the root
user and the user’s password.
Note that the MEMSQL_
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.sdb-admin add-aggregator --host memsql-01 --port 3306 --password '<<fooismypassword'
Examples
sdb-admin add-aggregator --memsql-id 0123ABCDEF
sdb-admin add-aggregator --host memsql-01 --port 3306
Usage
Usage:
sdb-admin add-aggregator [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
-h, --help Help for add-aggregator
--host string The cluster-addressable hostname for the aggregator
--memsql-id MemsqlID The node ID of the node to be added as an aggregator
-p, --password STRING The database user's password. If a password is specified on the command line,
it must not contain an unescaped '$' character as it will be replaced by the shell.
If a password is not specified on the command line, Toolbox will attempt to read the
password from the ‘MEMSQL_PASSWORD’ environment variable.
If this variable is present but does not contain a value, or if the variable does not
exist, Toolbox will prompt for a password
--port PORT The cluster-addressable port for the aggregator
--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)
--skip-validate-env Skip environment validation
--user string The database user (default "root")
Global Flags:
--backup-cache FILE_PATH File path for the backup cache
--cache-file FILE_PATH File path for the Toolbox node cache
-c, --config FILE_PATH File path for the Toolbox configuration
--disable-colors Disable color output in console, which some terminal sessions/environments may have difficulty with
--disable-spinner Disable the progress spinner, which some terminal sessions/environments may have issues with
-j, --json Enable JSON output
--parallelism POSITIVE_INTEGER Maximum number of operations to run in parallel
--runtime-dir DIRECTORY_PATH Where to store Toolbox runtime data
--ssh-control-persist SECONDS Enable SSH ControlPersist and set it to the specified duration in seconds
--ssh-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3
--ssh-strict-host-key-checking Enable strict host key checking for SSH connections
--ssh-user-known-hosts-file FILE_PATH Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
--state-file FILE_PATH Toolbox state file path
-v, --verbosity count Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
-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 use either --yes
or --json
flag to override interactive behavior.
Last modified: April 8, 2025