Outdated Version

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

SingleStore Tools Reference


This topic does not apply to MemSQL Helios.

The MemSQL management tools allow you to perform cluster management operations for setup, configuration, and diagnostics. Operations are done through CLI commands, which allows them to be easily scriptable for a variety of deployment environments and scenarios.

Most of the tools are part of the singlestoredb-toolbox package; however, the lower-level management tool, memsqlctl, is part of the memsql-server package (along with the MemSQL engine itself). Along with these packages, MemSQL also offers a client application through the singlestore-client package to connect to your MemSQL cluster and run queries.

All MemSQL packages are available through Apt and Yum repositories for easy integration with existing workflows.

The MemSQL management tools are as follows:

  • sdb-toolbox-config: Performs host machine registration.

  • sdb-deploy: Installs the memsql-server package that contains memsqlctl and the MemSQL database engine.

  • sdb-admin: Helps you manage a MemSQL cluster.

  • sdb-report: Collects and performs diagnostic checks on your cluster.

  • memsqlctl: Provides lower-level access to manage nodes on a host machine.

To see how download, install, and use these tools to deploy a new cluster, visit the MemSQL deployment guide.