Join the SingleStore Community Today
Get expert advice, develop skills, and connect with others.

help

Info

SingleStore Managed Service does not support this command.

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

Usage

memsql-toolbox-config help [flags]
memsql-deploy help [flags]
memsql-admin help [flags]
memsql-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

Remarks

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

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

Output

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 SingleStore DB (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 theSingleStore DB 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