Outdated Version

You are viewing an older version of this section. View current production version.

MemSQL Ops Command Mappings


This topic does not apply to SingleStore Managed Service.

When transitioning from a cluster managed by MemSQL Ops to one managed by the management tools in the singlestoredb-toolbox and memsql-server packages, it is helpful to know which commands and functionality used in MemSQL Ops translate over to the newer tools.

In some cases, there is a direct 1:1 mapping between commands that perform similar functions. In other cases, more than one command may be required to achieve equivalent functionality, or there may not be an equivalent command or set of commands because that functionality is no longer needed when using the new management tools.

Each section below lists the Ops commands and their respective SingleStore Tools commands. For cases where the Ops feature or command is no longer applicable, there will be a note in the table or section.

Node Management

MemSQL Ops command Description SingleStore Tools command
sdb-deploy Deploy a node. sdb-admin create-node followed up by sdb-admin bootstrap-aggregator, sdb-admin add-leaf or sdb-admin add-aggregator
memsql-list List all online nodes in the cluster. sdb-admin list-nodes

As this command lists only online nodes, it does not always present a complete state of the cluster and therefore should not be used to verify the cluster state.

To list all nodes in the cluster, use sdb-admin show-leaves and sdb-admin show-aggregators.
memsql-start Start a node. sdb-admin start-node
memsql-stop Stop a node. sdb-admin stop-node
memsql-restart Restart a node. sdb-admin restart-node
memsql-monitor Start monitoring a node in MemSQL Ops. sdb-admin register-node
memsql-unmonitor Stop monitoring a node in MemSQL Ops. sdb-admin unregister-node
memsql-update-config Change a config value for a node. sdb-admin update-config
memsql-update-root-password Update the root password for a node. sdb-admin change-root-password
memsql-upgrade Stop, upgrade, and restart all nodes in the cluster. sdb-deploy upgrade
memsql-optimize Optimize the cluster for maximum performance. sdb-admin optimize
memsql-enable-high-availability Enable high availability for the memsql cluster. sdb-admin enable-high-availability
memsql-path Get the directory where a given node is installed. sdb-admin describe-node
memsql-delete Delete a node and all of its data. sdb-admin delete-node

License Management

MemSQL Ops command Description SingleStore Tools command
license-list List all registered licenses. sdb-admin show-license
license-add Add a license.
This license will be deployed to all memsql nodes.
sdb-admin set-license

MemSQL Ops Tools

MemSQL Ops command Description SingleStore Tools command
report Generate a report that contains diagnostic information
for MemSQL Ops.
sdb-report collect

Backup Management

The SingleStore management tools do not have equivalent commands to memsql-ops database-backup and memsql-ops database-restore. Instead, you must perform backup and restore operations when logged into a cluster through either the SingleStore client application (found in singlestore-client package), SingleStore DB Studio, or another MySQL-compatible client. This approach allows you to take advantage of additional options such as backing up and restoring to AWS S3 or Azure Blob Storage.

See Backing up and Restoring Data for more details.

Ops Commands Without Equivalent Tools Commands

Because the new SingleStore Tools do not use an agent, manage job tasks, perform file management tasks, or have the concept of a superuser, there are no mappings defined for any of the following commands:

Local MemSQL Ops Agent Management

Remote MemSQL Ops Agent Management

MemSQL Ops Job Management

MemSQL Ops File Management

MemSQL Ops Superuser Management