{
"name": "mysql",
"description": "Mysql is a terminal-based front-end to MySQL",
"options": [
{
"names": [
"--auto-rehash"
],
"description": "Enable automatic rehashing"
},
{
"names": [
"--auto-vertical-output"
],
"description": "Enable automatic vertical result set display"
},
{
"names": [
"--batch",
"-B"
],
"description": "Do not use history file"
},
{
"names": [
"--binary-as-hex"
],
"description": "Display binary values in hexadecimal notation"
},
{
"names": [
"--binary-mode"
],
"description": "Disable \\r\\n - to - \\n translation and treatment of \\0 as end-of-query"
},
{
"names": [
"--bind-address"
],
"description": "Use specified network interface to connect to MySQL Server",
"takes_arg": true,
"arg": {
"name": "ip_address"
}
},
{
"names": [
"--character-sets-dir"
],
"description": "Directory where character sets are installed",
"takes_arg": true,
"arg": {
"name": "dir_name",
"description": "Directory where character sets are installed",
"template": "folders"
}
},
{
"names": [
"--column-names"
],
"description": "Write column names in results"
},
{
"names": [
"--column-type-info"
],
"description": "Display result set metadata"
},
{
"names": [
"--comments",
"-c"
],
"description": "Whether to retain or strip comments in statements sent to the server"
},
{
"names": [
"--compress",
"-C"
],
"description": "Compress all information sent between client and server"
},
{
"names": [
"--compression-algorithms"
],
"description": "Permitted compression algorithms for connections to server",
"takes_arg": true,
"arg": {
"name": "value",
"suggestions": [
"zlib",
"zstd",
"uncompressed"
]
}
},
{
"names": [
"--connect-expired-password"
],
"description": "Indicate to server that client can handle expired-password sandbox mode"
},
{
"names": [
"--connect-timeout"
],
"description": "Number of seconds before connection timeout",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"-D",
"--database"
],
"description": "The database to use",
"takes_arg": true,
"arg": {
"name": "db_name"
}
},
{
"names": [
"--debug"
],
"description": "Write debugging log; supported only if MySQL was built with debugging support"
},
{
"names": [
"--debug-check"
],
"description": "Print debugging information when program exits"
},
{
"names": [
"-T",
"--debug-info"
],
"description": "Print debugging information, memory, and CPU statistics when program exits"
},
{
"names": [
"--default-auth"
],
"description": "Authentication plugin to use",
"takes_arg": true,
"arg": {
"name": "plugin"
}
},
{
"names": [
"--default-character-set"
],
"description": "Specify default character set",
"takes_arg": true,
"arg": {
"name": "charset_name"
}
},
{
"names": [
"--defaults-extra-file"
],
"description": "Read named option file in addition to usual option files",
"takes_arg": true,
"arg": {
"name": "file_name",
"template": "filepaths"
}
},
{
"names": [
"--defaults-file"
],
"description": "Read only named option file",
"takes_arg": true,
"arg": {
"name": "file_name",
"template": "filepaths"
}
},
{
"names": [
"--defaults-group-suffix"
],
"description": "Option group suffix value",
"takes_arg": true,
"arg": {
"name": "str"
}
},
{
"names": [
"--delimiter"
],
"description": "Set the statement delimiter",
"takes_arg": true,
"arg": {
"name": "str"
}
},
{
"names": [
"--disable-named-commands"
],
"description": "Disable named commands. Use the \\* form only, or use named commands only at the beginning of a line ending with a semicolon (;). mysql starts with this option enabled by default. However, even with th"
},
{
"names": [
"--dns-srv-name"
],
"description": "Use DNS SRV lookup for host information",
"takes_arg": true,
"arg": {
"name": "name"
}
},
{
"names": [
"--enable-cleartext-plugin"
],
"description": "Enable cleartext authentication plugin"
},
{
"names": [
"-e",
"--execute"
],
"description": "Execute the statement and quit",
"takes_arg": true,
"arg": {
"name": "statement"
}
},
{
"names": [
"-f",
"--force"
],
"description": "Continue even if an SQL error occurs"
},
{
"names": [
"--get-server-public-key"
],
"description": "Request RSA public key from server"
},
{
"names": [
"--help",
"-?"
],
"description": "Display help message and exit"
},
{
"names": [
"--histignore"
],
"description": "Patterns specifying which statements to ignore for logging"
},
{
"names": [
"-h",
"--host"
],
"description": "Host on which MySQL server is located",
"takes_arg": true,
"arg": {
"name": "host_name"
}
},
{
"names": [
"-H",
"--html"
],
"description": "Produce HTML output"
},
{
"names": [
"-i",
"--ignore-spaces"
],
"description": "Ignore spaces after function names"
},
{
"names": [
"--init-command"
],
"description": "SQL statement to execute after connecting",
"takes_arg": true,
"arg": {
"name": "command"
}
},
{
"names": [
"--line-numbers"
],
"description": "Write line numbers for errors"
},
{
"names": [
"--load-data-local-dir"
],
"description": "Directory for files named in LOAD DATA LOCAL statements",
"takes_arg": true,
"arg": {
"name": "dir_name",
"template": "folders"
}
},
{
"names": [
"--local-infile"
],
"description": "Enable or disable for LOCAL capability for LOAD DATA",
"takes_arg": true,
"arg": {
"name": "is-local-inflie",
"suggestions": [
"0",
"1"
]
}
},
{
"names": [
"--login-path"
],
"description": "Read login path options from .mylogin.cnf",
"takes_arg": true,
"arg": {
"name": "name"
}
},
{
"names": [
"--max-allowed-packet"
],
"description": "Maximum packet length to send to or receive from server",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"--max-join-size"
],
"description": "The automatic limit for rows in a join when using --safe-updates",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"-G",
"--named-commands"
],
"description": "Enable named mysql commands"
},
{
"names": [
"--net-buffer-length"
],
"description": "Buffer size for TCP/IP and socket communication",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"--network-namespace"
],
"description": "Specify network namespace",
"takes_arg": true,
"arg": {
"name": "name"
}
},
{
"names": [
"-A",
"--no-auto-rehash"
],
"description": "Disable automatic rehashing"
},
{
"names": [
"--no-beep",
"-b"
],
"description": "Do not beep when errors occur"
},
{
"names": [
"--no-defaults"
],
"description": "Read no option files"
},
{
"names": [
"-o",
"--one-database"
],
"description": "Ignore statements except those for the default database named on the command line"
},
{
"names": [
"--pager"
],
"description": "Use the given command for paging query output",
"takes_arg": true,
"arg": {
"name": "command"
}
},
{
"names": [
"-p",
"--password"
],
"description": "Password to use when connecting to server",
"takes_arg": true,
"arg": {
"name": "password"
}
},
{
"names": [
"--pipe",
"-W"
],
"description": "Connect to server using named pipe (Windows only)"
},
{
"names": [
"--plugin-dir"
],
"description": "Directory where plugins are installed",
"takes_arg": true,
"arg": {
"name": "dir_name",
"template": "folders"
}
},
{
"names": [
"-P",
"--port"
],
"description": "TCP/IP port number for connection",
"takes_arg": true,
"arg": {
"name": "port_num"
}
},
{
"names": [
"--print-defaults"
],
"description": "Print default options"
},
{
"names": [
"--prompt"
],
"description": "Set the prompt to the specified format",
"takes_arg": true,
"arg": {
"name": "format_str"
}
},
{
"names": [
"--protocol"
],
"description": "Transport protocol to use",
"takes_arg": true,
"arg": {
"name": "format_str",
"suggestions": [
"TCP",
"SOCKET",
"PIPE",
"MEMORY"
]
}
},
{
"names": [
"-q",
"--quick"
],
"description": "Do not cache each query result"
},
{
"names": [
"-r",
"--raw"
],
"description": "Write column values without escape conversion"
},
{
"names": [
"--reconnect"
],
"description": "If the connection to the server is lost, automatically try to reconnect"
},
{
"names": [
"-U",
"--safe-updates",
"--i-am-a-dummy"
],
"description": "Allow only UPDATE and DELETE statements that specify key values"
},
{
"names": [
"--select-limit"
],
"description": "The automatic limit for SELECT statements when using --safe-updates",
"takes_arg": true,
"arg": {
"name": "value"
}
},
{
"names": [
"--server-public-key-path"
],
"description": "Path name to file containing RSA public key",
"takes_arg": true,
"arg": {
"name": "filename",
"template": "filepaths"
}
},
{
"names": [
"--shared-memory-base-name"
],
"description": "Shared-memory name for shared-memory connections (Windows only)",
"takes_arg": true,
"arg": {
"name": "name"
}
},
{
"names": [
"--show-warnings"
],
"description": "Show warnings after each statement if there are any"
},
{
"names": [
"--sigint-ignore"
],
"description": "Ignore SIGINT signals (typically the result of typing Control+C)"
},
{
"names": [
"-s",
"--silent"
],
"description": "Silent mode. Produce less output. This option can be given multiple times to produce less and less output"
},
{
"names": [
"--skip-auto-rehash"
],
"description": "Disable automatic rehashing"
},
{
"names": [
"-N",
"--skip-column-names"
],
"description": "Do not write column names in results"
},
{
"names": [
"-L",
"--skip-line-numbers"
],
"description": "Skip line numbers for errors"
},
{
"names": [
"--skip-named-commands"
],
"description": "Disable named mysql commands"
},
{
"names": [
"--skip-pager"
],
"description": "Disable paging"
},
{
"names": [
"--skip-reconnect"
],
"description": "Disable reconnecting"
},
{
"names": [
"-S",
"--socket"
],
"description": "Unix socket file or Windows named pipe to use\"File that contains list of trusted SSL Certificate Authorities\"",
"takes_arg": true,
"arg": {
"name": "name"
}
},
{
"names": [
"--ssl-ca"
],
"description": "File that contains list of trusted SSL Certificate Authorities",
"takes_arg": true,
"arg": {
"name": "filename",
"template": "filepaths"
}
},
{
"names": [
"--ssl-capath"
],
"description": "Directory that contains trusted SSL Certificate Authority certificate files",
"takes_arg": true,
"arg": {
"name": "dirname",
"template": "folders"
}
},
{
"names": [
"--ssl-cert"
],
"description": "File that contains X.509 certificate",
"takes_arg": true,
"arg": {
"name": "filename",
"template": "filepaths"
}
},
{
"names": [
"--ssl-cipher"
],
"description": "Permissible ciphers for connection encryption"
},
{
"names": [
"--ssl-crl"
],
"description": "File that contains certificate revocation lists",
"takes_arg": true,
"arg": {
"name": "filename",
"template": "filepaths"
}
},
{
"names": [
"--ssl-crlpath"
],
"description": "Directory that contains certificate revocation-list files",
"takes_arg": true,
"arg": {
"name": "dirname",
"template": "folders"
}
},
{
"names": [
"--ssl-fips-mode"
],
"description": "Whether to enable FIPS mode on client side",
"takes_arg": true,
"arg": {
"name": "mode",
"suggestions": [
"OFF",
"ON",
"STRICT"
]
}
},
{
"names": [
"--ssl-key"
],
"description": "File that contains X.509 key",
"takes_arg": true,
"arg": {
"name": "filename",
"template": "filepaths"
}
},
{
"names": [
"--ssl-mode"
],
"description": "Desired security state of connection to server"
},
{
"names": [
"-j",
"--syslog"
],
"description": "Log interactive statements to syslog"
},
{
"names": [
"-t",
"--table"
],
"description": "Display output in tabular format"
},
{
"names": [
"--tee"
],
"description": "Append a copy of output to named file",
"takes_arg": true,
"arg": {
"name": "file_name",
"template": "filepaths"
}
},
{
"names": [
"--tls-ciphersuites"
],
"description": "Permissible TLSv1.3 ciphersuites for encrypted connections",
"takes_arg": true,
"arg": {
"name": "ciphersuite_list",
"template": "filepaths"
}
},
{
"names": [
"--tls-version"
],
"description": "Permissible TLS protocols for encrypted connections",
"takes_arg": true,
"arg": {
"name": "protocol_list"
}
},
{
"names": [
"-n",
"--unbuffered"
],
"description": "Flush the buffer after each query"
},
{
"names": [
"-u",
"--user"
],
"description": "MySQL user name to use when connecting to server",
"takes_arg": true,
"arg": {
"name": "user_name"
}
},
{
"names": [
"-v",
"--verbose"
],
"description": "Verbose mode"
},
{
"names": [
"-V",
"--version"
],
"description": "Display version information and exit"
},
{
"names": [
"-E",
"--vertical"
],
"description": "Print query output rows vertically (one line per column value)"
},
{
"names": [
"-w",
"--wait"
],
"description": "If the connection cannot be established, wait and retry instead of aborting"
},
{
"names": [
"-X",
"--xml"
],
"description": "Produce XML output"
},
{
"names": [
"--zstd-compression-level"
],
"description": "Compression level for connections to server that use zstd compression",
"takes_arg": true,
"arg": {
"name": "level",
"description": "Compression level between 1-22. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression"
}
}
]
}