Common Tools Commands

Display the runtime environment for a SingleStore tool.

sdb-toolbox-config env [flags]
sdb-deploy env [flags]
sdb-admin env [flags]
sdb-report env [flags]

Flags:
  -h, --help   help for env

Global Flags:
  -c, --config FILE_PATH       the Toolbox configuration file path
  -j, --json                   Enable JSON output
      --socket-dir FILE_PATH   where to put SSH ControlMaster sockets
      --state-file FILE_PATH   the Toolbox state file path
      --timeout duration       Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -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 is interactive unless you use either --yes or --json flag to override interactive behavior.

The following example uses the env command to display the current configuration paths for the SingleStore Tools.

sdb-toolbox-config env
****
+------------+-------------------------------------------------------------+
| configFile |                                                             |
| stateFile  | /home/vagrant/.local/share/memsql-toolbox/toolbox-state.hcl |
| cacheFile  | /home/vagrant/.local/share/memsql-toolbox/toolbox-cache.hcl |
| socketDir  | /run/user/1000/singlestoredb-toolbox                               |
| sshBinary  | /usr/bin/ssh                                                |
+------------+-------------------------------------------------------------+

Provides help for any command in the application. Type <application> help [command] for full details.

sdb-toolbox-config help [flags]
sdb-deploy help [flags]
sdb-admin help [flags]
sdb-report help [flags]
memsqlctl help [flags]

Flags:
  -h, --help   help for help

Global Flags:
  -c, --config FILE_PATH       the Toolbox configuration file path
  -j, --json                   Enable JSON output
      --socket-dir FILE_PATH   where to put SSH ControlMaster sockets
      --state-file FILE_PATH   the Toolbox state file path
      --timeout duration       Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -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

You can also retrieve help for any command by typing <application> [command] --help.

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

The following is the standard output for the help command.

memsqlctl help show-license
****
Show license information for a node on this host
 Usage:
  memsqlctl show-license [flags]
 Flags:
  -h, --help               help for show-license
      --memsql-id string   the SingleStoreDB (MemSQL) ID of the node
 Global Flags:
  -c, --config FILE_PATH                     Path to the memsqctl config file
      --default-install-dir DIRECTORY_PATH   Path to the default install directory
  -j, --json                                 Print output in JSON format
      --node-metadata-file FILE_PATH         Path to the node metadata file
      --ssl-ca FILE_PATH                     Path to the CA certificate file in PEM format to authenticate the SingleStoreDB server certificate
      --timeout duration                     Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -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

Display the version of a SingleStore tool.

sdb-toolbox-config version [flags]
sdb-deploy version [flags]
sdb-admin version [flags]
sdb-report version [flags]
memsqlctl version [flags]

Flags:
      --commit-hash   Display the commit hash instead of the version number
  -h, --help          help for version

Global Flags:
  -c, --config FILE_PATH       the Toolbox configuration file path
  -j, --json                   Enable JSON output
      --socket-dir FILE_PATH   where to put SSH ControlMaster sockets
      --state-file FILE_PATH   the Toolbox state file path
      --timeout duration       Maximum time for operation to complete (e.g., 30s, 10m, 1.5h)
  -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 is interactive unless you use either --yes or --json flag to override interactive behavior.

The following example uses the version command to display the version of the currently-installed sdb-deploy tool.

sdb-deploy version
****
1.0.0