SingleStore Tools Reference

Overview

The SingleStore 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 singlestoredb-server package (along with the SingleStore engine itself). Along with these packages, SingleStore also offers a client application through the singlestore-client package to connect to your SingleStore cluster and run queries.

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

The SingleStore management tools are as follows:

• sdb-toolbox-config Commands: Perform host machine registration.

• sdb-deploy Commands: Install the singlestoredb-server package that contains memsqlctl and the SingleStore database engine.

• sdb-admin Commands: Help you manage a SingleStore cluster.

• sdb-report Commands: Collect and perform diagnostic checks on your cluster.

• memsqlctl Commands: Provide 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 SingleStore deployment guide.