Provided by: mysql-shell_8.0.36+dfsg-0ubuntu1_amd64 bug

NAME

       mysqlsh - the MySQL shell

SYNOPSIS

       mysqlsh [options] db_name

DESCRIPTION

       MySQL Shell is an advanced command-line client and code editor for MySQL. In addition to
       SQL, MySQL Shell also offers scripting capabilities for JavaScript and Python. For
       information about using MySQL Shell, see MySQL Shell 8.0. When MySQL Shell is connected to
       the MySQL Server through the X Protocol, the X DevAPI can be used to work with both
       relational and document data, see Using MySQL as a Document Store[1]. MySQL Shell includes
       the AdminAPI that enables you to work with InnoDB Cluster, InnoDB ClusterSet, and InnoDB
       ReplicaSet deployments; see Chapter 6, MySQL AdminAPI.

       Many of the options described here are related to connections between MySQL Shell and a
       MySQL Server instance. See Section 4.3, “MySQL Shell Connections” for more information.

       mysqlsh supports the following command-line options.

       •   --help, -?

           Display a help message and exit.

       •   --

           Marks the end of the list of mysqlsh options and the start of a command and its
           arguments for MySQL Shell's API command line integration. You can execute methods of
           the MySQL Shell global objects from the command line using this syntax:

               mysqlsh [options]  -- object method [arguments]

           See Section 5.8, “API Command Line Integration” for more information.

       •   --auth-method=method

           Authentication method to use for the account. Depends on the authentication plugin
           used for the account's password. For MySQL Shell connections using classic MySQL
           protocol, specify the name of the authentication plugin, for example
           caching_sha2_password. For MySQL Shell connections using X Protocol, specify one of
           the following options:

           AUTO
               Let the library select the authentication method.

           FALLBACK
               Let the library select the authentication method, but do not use any
               authentication method that is not compatible with MySQL 5.7.

           FROM_CAPABILITIES
               Let the library select the authentication method, using the capabilities announced
               by the server instance.

           MYSQL41
               Use the challenge-response authentication protocol supported by MySQL 4.1 and
               later, which does not send a plaintext password. This option is compatible with
               accounts that use the mysql_native_password authentication plugin.

           PLAIN
               Send a plaintext password for authentication. Use this option only with encrypted
               connections. This option can be used to authenticate with cached credentials for
               an account that uses the caching_sha2_password authentication plugin, provided
               there is an SSL connection. See Using X Plugin with the Caching SHA-2
               Authentication Plugin[2].

           SHA256_MEMORY
               Authenticate using a hashed password stored in memory. This option can be used to
               authenticate with cached credentials for an account that uses the
               caching_sha2_password authentication plugin, where there is a non-SSL connection.
               See Using X Plugin with the Caching SHA-2 Authentication Plugin[2].

           For MySQL Shell connections using classic MySQL protocol, specify the name of the
           authentication plugin used by the user account, for example caching_sha2_password
           (which is the default for user accounts created in MySQL 8.0). MySQL Shell uses the
           MySQL client library for client-side authentication for these connections. The
           following authentication methods require additional configuration:

           clear_text_password
               The mysql_clear_password client-side plugin is required for simple LDAP
               authentication. It is built in to the MySQL client library, but for security it is
               not enabled by default. From MySQL Shell 8.0.27, MySQL Shell enables and uses the
               plugin when you specify it with the --auth-method=clear_text_password connection
               option. This authentication type is only suitable for a secure connection that
               uses SSL or sockets, so you must configure the secure connection before using it.
               Note that with the option ssl-mode=preferred, the SSL connection is not
               guaranteed, so a connection with this option set is not considered to be an SSL
               connection. For more information, see Section 4.3.4, “Using Encrypted
               Connections”.

           authentication_ldap_sasl_client
               The authentication_ldap_sasl_client client-side plugin is for SASL-based LDAP
               authentication, including GSSAPI/Kerberos authentication. It is not built in to
               the MySQL client library, but it is shipped in the MySQL Server packages. To load
               it, you must use the --mysql-plugin-dir option (available from MySQL Shell 8.0.27)
               to specify a path to the plugin in the MySQL Server packages.

           authentication_kerberos_client
               The authentication_kerberos_client client-side plugin is for Kerberos
               authentication. It is not built in to the MySQL client library, but it is shipped
               in the MySQL Server packages. To load it, you must use the --mysql-plugin-dir
               option (available from MySQL Shell 8.0.27) to specify a path to the plugin in the
               MySQL Server packages.

           Cached ticket-granting tickets (TGTs) for Kerberos authentication are supported from
           MySQL 8.0.27 when the --auth-method option is used to specify the
           authentication_ldap_sasl_client or authentication_kerberos_client plugin, and the
           --mysql-plugin-dir option is used to provide a path to the plugin. To use cached TGTs,
           do not specify a user and password in the connection options. When you specify one of
           these plugins and do not specify a user and password, MySQL Shell does not supply the
           system user name, does not prompt for a password, and does not attempt to use the
           Secret Store helper to retrieve or store credentials.

           For more information, see Section 4.3.5, “Using LDAP and Kerberos Authentication”.

       •   --cluster

           Ensures that the target server is part of an InnoDB Cluster and if so, sets the
           cluster global variable to the cluster object.

       •   --column-type-info

           In SQL mode, before printing the returned result set for a query, print metadata for
           each column in the result set, such as the column type and collation.

           The column type is returned as both the type used by MySQL Shell (Type), and the type
           used by the original database (DBType). For MySQL Shell connections using classic
           MySQL protocol, DBType is as returned by the protocol, and for X Protocol connections,
           DBType is inferred from the available information. The column length (Length) is
           returned in bytes.

       •   --compress[={required|preferred|disabled}], -C [{required|preferred|disabled}]

           Controls compression of information sent between the client and the server using this
           connection. In MySQL Shell 8.0.14 through 8.0.19 this option is available for classic
           MySQL protocol connections only, and does not use the options required, preferred, and
           disabled. In those releases, when you specify --compress, compression is activated if
           possible. From MySQL Shell 8.0.20 it is also available for X Protocol connections, and
           you can optionally specify required, preferred, or disabled. When just --compress is
           specified from MySQL Shell 8.0.20, the meaning is --compress=required. See
           Section 4.3.7, “Using Compressed Connections” for information on using MySQL Shell's
           compression control in all releases.

       •   --connect-timeout=ms

           Configures how long MySQL Shell waits (in milliseconds) to establish a global session
           specified through command-line arguments.

       •   --credential-store-helper=helper

           The Secret Store Helper that is to be used to store and retrieve passwords. See
           Section 4.4, “Pluggable Password Store”.

       •   --database=name, -D name

           The default schema to use. This is an alias for --schema.

       •   --dba=enableXProtocol

           Enable X Plugin on connection with a MySQL 5.7 server, so that you can use X Protocol
           connections for subsequent connections. Requires a connection using classic MySQL
           protocol. Not relevant for MySQL 8.0 servers, which have X Plugin enabled by default.

       •   --dba-log-sql[=0|1|2]

           Log SQL statements that are executed by AdminAPI operations (excluding sandbox
           operations). By default, this category of statement is not written to the MySQL Shell
           application log file or sent to the console as verbose output, even when the
           --log-level and --verbose options are set. The value of the option is an integer in
           the range from 0 to 2. 0 does not log or display this category of statement, which is
           the default behavior if you do not specify the option. 1 logs SQL statements that are
           executed by AdminAPI operations, with the exceptions of SELECT statements and SHOW
           statements (this is the default setting if you specify the option on the command line
           without a value). 2 logs SQL statements that are executed by regular AdminAPI
           operations in full, including SELECT and SHOW statements. See Chapter 12, MySQL Shell
           Logging and Debug for more information.

       •   --log-sql[=off|error|on|all|unfiltered]

           Log all SQL statements executed by MySQL Shell to the MySQL Shell log file,
           mysqlsh.log

           The following options are available:

           off
               No MySQL Shell SQL statements are logged.

           error
               (Default value) only MySQL Shell failed SQL statements with are logged.

           on
               All MySQL Shell SQL statements are logged, except those which match the ignore
               pattern defined in logSql.ignorePattern and logSql.ignorePatternUnsafe. See the
               section called “Filtering SQL Logging” for more information.

           all
               All MySQL Shell SQL statements are logged, except those which match the ignore
               pattern defined in logSql.ignorePatternUnsafe. See the section called “Filtering
               SQL Logging” for more information.

           unfiltered
               All MySQL Shell SQL statements are logged, no filtering is performed.

       •   --dbpassword[=password]

           Deprecated in version 8.0.13 of MySQL Shell. Use --password[=password] instead.

       •   --dbuser=user_name

           Deprecated in version 8.0.13 of MySQL Shell. Use --user=user_name instead.

       •   --execute=command, -e command

           Execute the command using the currently active language and quit. This option is
           mutually exclusive with the --file=file_name option.

       •   --fido-register-factor

           The factor or factors for which FIDO device registration must be performed. This
           option value must be a single value, or two values separated by commas. Each value
           must be 2 or 3, so the permitted option values are '2', '3', '2,3' and '3,2'. For
           example:

               mysqlsh --user=user_name --password1 --fido-register-factor=2
               Enter password: (enter factor 1 password)

           To register an account for passwordless authentication, with the FIDO device being the
           only authentication, you use --fido-register-factor=2 to provide the temporary
           password. The server moves FIDO authentication to the first factor after registration
           succeeds.

               Note
               MySQL Shell prompts for a password if you do not specify one when connecting to
               the server. After you set up passwordless authentication with a FIDO device, use
               one of the following methods to bypass the password prompt when you make a
               connection:

               •   Specify the connection option --no-password, or --password= with an empty
                   value.

               •   Place a colon (:) after the user name in the connection string, for example:
                   mysqlsh user_name:@localhost

               •   Press Enter when the password prompt appears.
           MySQL Shell’s --fido-register-factor option works in the same way as the mysql client
           option. For more details and instructions, see FIDO Pluggable Authentication[3].

       •   --file=file_name, -f file_name

           Specify a file to process in Batch mode. Any options specified after this are used as
           arguments of the processed file.

       •   --force

           Continue processing in SQL and Batch modes even if errors occur.

       •   --histignore=strings

           Specify strings that are not added to the MySQL Shell history. Strings are separated
           by a colon. Matching is case insensitive, and the wildcards * and ? can be used. The
           default ignored strings are specified as “*IDENTIFIED*:*PASSWORD*”. See Section 5.5,
           “Code History”.

       •   --host=host_name, -h host_name

           Connect to the MySQL server on the given host. On Windows, if you specify --host=.  or
           -h .  (giving the host name as a period), MySQL Shell connects using the default named
           pipe (which has the name MySQL), or an alternative named pipe that you specify using
           the --socket option.

       •   --get-server-public-key

           MySQL Shell equivalent of --get-server-public-key.

           If --server-public-key-path=file_name is given and specifies a valid public key file,
           it takes precedence over --get-server-public-key.

               Important
               Only supported with classic MySQL protocol connections.
           See Caching SHA-2 Pluggable Authentication[4].

       •   --import

           Import JSON documents from a file or standard input to a MySQL Server collection or
           relational table, using the JSON import utility. For instructions, see Section 11.2,
           “JSON Import Utility”.

       •   --interactive[=full], -i

           Emulate Interactive mode in Batch mode.

       •   --js, --javascript

           Start in JavaScript mode.

       •   --json[={off|pretty|raw}]

           Controls JSON wrapping for MySQL Shell output from this session. This option is
           intended for interfacing MySQL Shell with other programs, for example as part of
           testing. For changing query results output to use the JSON format, see
           --result-format.

           When the --json option has no value or a value of pretty, the output is generated as
           pretty-printed JSON. With a value of raw, the output is generated in raw JSON format.
           In any of these cases, the --result-format option and its aliases and the value of the
           resultFormat MySQL Shell configuration option are ignored. With a value of off, JSON
           wrapping does not take place, and result sets are output as normal in the format
           specified by the --result-format option or the resultFormat configuration option.

       •   --log-file=path

           Change the location of the MySQL Shell application log file mysqlsh.log for this MySQL
           Shell instance. The default location for the application log file is the user
           configuration path, which defaults to %APPDATA%\MySQL\mysqlsh\ on Windows or
           ~/.mysqlsh/ on Unix. You can override the user configuration path for all MySQL Shell
           instances by defining the environment variable MYSQLSH_USER_CONFIG_HOME. The
           --log-file option applies to the individual MySQL Shell instance, meaning that
           different instances can write to different locations.

       •   --log-level=N

           Change the logging level for the MySQL Shell application log file mysqlsh.log, or
           disable logging to the file. The option requires a value, which can be either an
           integer in the range from 1 to 8, or one of none, internal, error, warning, info,
           debug, debug2, or debug3. Specifying 1 or none disables logging to the application log
           file. Level 5 (info) is the default if you do not specify this option. See Chapter 12,
           MySQL Shell Logging and Debug.

       •   -ma

           Deprecated in version 8.0.13 of MySQL Shell. Automatically attempts to use X Protocol
           to create the session's connection, and falls back to classic MySQL protocol if X
           Protocol is unavailable.

       •   --mysql, --mc

           Sets the global session created at start up to use a classic MySQL protocol
           connection. The --mc option with two hyphens replaces the previous single hyphen -mc
           option from MySQL Shell 8.0.13.

       •   --mysql-plugin-dir=path

           Sets a non-persistent path to the client-side authentication plugins by overriding the
           value of the shell.options.mysqlPluginDir setting. Client-side plugins are shipped in
           the MySQL Server packages and can be located relative to the MySQL base directory (the
           value of the basedir system variable). For example:

           •   C:\program files\mysql\mysql Server 8.0\lib\plugin on Windows host types

           •   /usr/local/mysql/lib/plugin on Linux host types

           For a list of the client authentication plugins that ship with the server, see
           Available Authentication Plugins[5].

       •   --mysqlx, --mx

           Sets the global session created at start up to use an X Protocol connection. The --mx
           option with two hyphens replaces the previous single hyphen -mx option from MySQL
           Shell 8.0.13.

       •   --name-cache

           Enable automatic loading of table names based on the active default schema.

       •   --no-name-cache, -A

           Disable loading of table names for autocompletion based on the active default schema
           and the DevAPI db object. Use \rehash to reload the name information manually.

       •   --no-password

           When connecting to the server, if the user has a passwordless account, which is
           insecure and not recommended, or if socket peer-credential authentication is in use
           (for Unix socket connections), you must use --no-password to explicitly specify that
           no password is provided and the password prompt is not required.

       •   --no-wizard, -nw

           Disables the interactive wizards provided by operations such as creating connections,
           dba.configureInstance(), Cluster.rebootClusterFromCompleteOutage() and so on. Use this
           option when you want to script MySQL Shell and not have the interactive prompts
           displayed. For more information see Section 5.6, “Batch Code Execution” and
           Section 5.8, “API Command Line Integration”.

       •   --pager=name

           The external pager tool used by MySQL Shell to display text output for statements
           executed in SQL mode and other selected commands such as online help. If you do not
           set a pager, the pager specified by the PAGER environment variable is used. See
           Section 4.6, “Using a Pager”.

       •   --passwords-from-stdin

           Read the password from standard input, rather than from the terminal. This option does
           not affect any other password behaviors, such as the password prompt.

       •   --password[=password], -ppassword

           The password to use when connecting to the server. The maximum password length that is
           accepted for connecting to MySQL Shell is 128 characters.

           •   --password=password (-ppassword) with a value supplies a password to be used for
               the connection. With the long form --password=, you must use an equals sign and
               not a space between the option and its value. With the short form -p, there must
               be no space between the option and its value. If a space is used in either case,
               the value is not interpreted as a password and might be interpreted as another
               connection parameter.

               Specifying a password on the command line should be considered insecure. See
               End-User Guidelines for Password Security[6]. You can use an option file to avoid
               giving the password on the command line.

           •   --password with no value and no equal sign, or -p without a value, requests the
               password prompt.

           •   --password= with an empty value has the same effect as --no-password, which
               specifies that the user is connecting without a password. When connecting to the
               server, if the user has a passwordless account, which is insecure and not
               recommended, or if socket peer-credential authentication is in use (for Unix
               socket connections), you must use one of these methods to explicitly specify that
               no password is provided and the password prompt is not required.

       •   --password1[=password]

           --password1, --password2 and --password3 are the passwords to use for accounts that
           require multifactor authentication. You can supply up to three passwords. The options
           work in the same way as the --password option, and --password1 is treated as
           equivalent to that option. You can specify a password value following the option on
           the command line (which is insecure), or if the options are given without a password
           value, MySQL Shell prompts the user for each password in turn. These options are
           available from MySQL Shell 8.0.28, where they are only supported for classic MySQL
           protocol connections made using command-line arguments.

       •   --password2[=password]

           The password for the second authentication method for accounts that require
           multifactor authentication. See the description for the --password1 option.

       •   --password3[=password]

           The password for the third authentication method for accounts that require multifactor
           authentication. See the description for the --password1 option.

       •   --port=port_num, -P port_num

           The TCP/IP port number to use for the connection. The default is port 33060.

       •   --py, --python

           Start in Python mode.

       •   --pyc=pythonCommand, -c

           Execute a Python command and quit. Any options specified after this are treated as
           arguments of the processed command.

       •   --pym

           Execute the specified Python module as a script in MySQL Shell's Python mode.  --pym
           works in the same way as Python's -m command line option. This option is available
           from MySQL Shell 8.0.22.

       •   --quiet-start[=1|2]

           Start without printing introductory information. MySQL Shell normally prints
           information about the product, information about the session (such as the default
           schema and connection ID), warning messages, and any errors that are returned during
           startup and connection. When you specify --quiet-start with no value or a value of 1,
           information about the MySQL Shell product is not printed, but session information,
           warnings, and errors are printed. With a value of 2, only errors are printed.

       •   --recreate-schema

           Drop and recreate the schema that was specified in the connection options, either as
           part of a URI-like connection string or using the --schema, --database, or -D option.
           The schema is deleted if it exists.

       •   --redirect-primary

           Ensures that the target server is part of an InnoDB Cluster or InnoDB ReplicaSet and
           if it is not the primary, finds the primary and connects to it. MySQL Shell exits with
           an error if any of the following is true when using this option:

           •   No instance is specified

           •   On an InnoDB Cluster, Group Replication is not active

           •   InnoDB Cluster metadata does not exist

           •   There is no quorum

       •   --replicaset

           Ensures that the target server belongs to an InnoDB ReplicaSet, and if so, populates
           the rs global variable with the InnoDB ReplicaSet. You can then administer the InnoDB
           ReplicaSet using the rs global variable, for example by issuing rs.status().

       •   --redirect-secondary

           Ensures that the target server is part of a single-primary InnoDB Cluster or InnoDB
           ReplicaSet and if it is not a secondary, finds a secondary and connects to it. MySQL
           Shell exits with an error if any of the following is true when using this option:

           •   On an InnoDB Cluster, Group Replication is not active

           •   InnoDB Cluster metadata does not exist

           •   There is no quorum

           •   The cluster is not single-primary and is running in multi-primary mode

           •   There is no secondary available, for example because there is just one server
               instance

       •   --result-format={table|tabbed|vertical|json|json/pretty|ndjson|json/raw|json/array}

           Set the value of the resultFormat MySQL Shell configuration option for this session.
           Formats are as follows:

           table
               The default for interactive mode, unless another value has been set persistently
               for the resultFormat configuration option in the configuration file, in which case
               that default applies. The --table alias can also be used.

           tabbed
               The default for batch mode, unless another value has been set persistently for the
               resultFormat configuration option in the configuration file, in which case that
               default applies. The --tabbed alias can also be used.

           vertical
               Produces output equivalent to the \G terminator for an SQL query. The --vertical
               or -E aliases can also be used.

           json or json/pretty
               Produces pretty-printed JSON.

           ndjson or json/raw
               Produces raw JSON delimited by newlines.

           json/array
               Produces raw JSON wrapped in a JSON array.

           If the --json command line option is used to activate JSON wrapping for output for the
           session, the --result-format option and its aliases and the value of the resultFormat
           configuration option are ignored.

       •   --save-passwords={always|prompt|never}

           Controls whether passwords are automatically stored in the secret store.  always means
           passwords are always stored unless they are already in the store or the server URL is
           excluded by a filter.  never means passwords are never stored.  prompt, which is the
           default, means users are asked whether to store the password or not. See Section 4.4,
           “Pluggable Password Store”.

       •   --schema=name, -D name

           The default schema to use.

       •   --server-public-key-path=file_name

           MySQL Shell equivalent of --server-public-key-path.

           If --server-public-key-path=file_name is given and specifies a valid public key file,
           it takes precedence over --get-server-public-key.

               Important
               Only supported with classic MySQL protocol connections.
           See caching_sha2_password plugin Caching SHA-2 Pluggable Authentication[4].

       •   --show-warnings={true|false}

           When true is specified, which is the default, in SQL mode, MySQL Shell displays
           warnings after each SQL statement if there are any. If false is specified, warning are
           not displayed.

       •   --socket[=path], -S [path]

           On Unix, when a path is specified, the path is the name of the Unix socket file to use
           for the connection. If you specify --socket with no value and no equal sign, or -S
           without a value, the default Unix socket file for the appropriate protocol is used.

           On Windows, the path is the name of the named pipe to use for the connection. The pipe
           name is not case-sensitive. On Windows, you must specify a path, and the --socket
           option is available for classic MySQL protocol sessions only.

           You cannot specify a socket if you specify a port or a host name other than localhost
           on Unix or a period (.) on Windows.

       •   --sql

           Start in SQL mode, auto-detecting the protocol to use if it is not specified as part
           of the connection information. When the protocol to use is not specified, defaults to
           an X Protocol connection, falling back to a classic MySQL protocol connection. To
           force a connection to use a specific protocol see the --sqlx or --sqlc options.
           Alternatively, specify a protocol to use as part of a URI-like connection string or
           use the --port option. See Section 4.3, “MySQL Shell Connections” and MySQL Shell
           Ports[7]. for more information.

       •   --sqlc

           Start in SQL mode forcing the connection to use classic MySQL protocol, for example to
           use MySQL Shell with a server that does not support X Protocol. If you do not specify
           the port as part of the connection, when you provide this option MySQL Shell uses the
           default classic MySQL protocol port which is usually 3306. The port you are connecting
           to must support classic MySQL protocol, so for example if the connection you specify
           uses the X Protocol default port 33060, the connection fails with an error. See
           Section 4.3, “MySQL Shell Connections” and MySQL Shell Ports[7]. for more information.

       •   --sqlx

           Start in SQL mode forcing the connection to use X Protocol. If you do not specify the
           port as part of the connection, when you provide this option MySQL Shell uses the
           default X Protocol port which is usually 33060. The port you are connecting to must
           support X Protocol, so for example if the connection you specify uses the classic
           MySQL protocol default port 3306, the connection fails with an error. See Section 4.3,
           “MySQL Shell Connections” and MySQL Shell Ports[7]. for more information.

       •   --ssh=str

           Create an SSH tunnel that provides an encrypted connection to the MySQL server
           instance. Supply the URI for connection to the SSH server in the format
           [user@]host[:port], for example:

               --ssh root@198.51.100.4:2222

           When you use this option, you must also specify the --user, --host, and --port
           options, or a URI, for connection to the MySQL server instance. For information on SSH
           tunnel connections from MySQL Shell, see Section 4.3.6, “Using an SSH Tunnel”.

       •   --ssh-config-file=path

           Specify the path to an SSH configuration file for the connection to the SSH server.
           You can use the MySQL Shell configuration option ssh.configFile to set a custom file
           as the default if this option is not specified. If ssh.configFile has not been set,
           the default is the standard SSH configuration file ~/.ssh/config. If you specify
           --ssh-config-file with an empty value, the default file specified by ssh.configFile is
           ignored, and the ~/.ssh/config file is used instead.

       •   --ssh-identity-file=path

           Specify the path to an identity file for the connection to the SSH server. The default
           if this option is not specified is the standard private key file in the SSH
           configuration folder (~/.ssh/id_rsa).

       •   --ssl*

           Options that begin with --ssl specify whether to connect to the server using SSL and
           indicate where to find SSL keys and certificates. The mysqlsh SSL options function in
           the same way as the SSL options for MySQL Server, see Command Options for Encrypted
           Connections[8] for more information.

           mysqlsh accepts these SSL options: --ssl-mode, --ssl-ca, --ssl-capath, --ssl-cert,
           --ssl-cipher, --ssl-crl, --ssl-crlpath, --ssl-key, --tls-version.

       •   --syslog

           Send SQL statements that you issue in MySQL Shell’s SQL mode to the operating system’s
           system logging facility (syslog on Unix, or the Windows Event Log). System logging for
           SQL statements only takes place when MySQL Shell is started in interactive mode, so
           either a normal start or a start with the --interactive option. It does not take place
           if the --execute or --file options are used at startup to run mysqlsh in batch mode.
           See Section 12.3, “System Logging for User SQL Statements” for more information.

       •   --tabbed

           Display results in tab separated format in interactive mode. The default for that mode
           is table format. This option is an alias of the --result-format=tabbed option.

       •   --table

           Display results in table format in batch mode. The default for that mode is tab
           separated format. This option is an alias of the --result-format=table option.

       •   --uri=str

           Create a connection upon startup, specifying the connection options in a URI-like
           string as described at Connecting to the Server Using URI-Like Strings or Key-Value
           Pairs[9].

       •   --user=user_name, -u user_name

           The MySQL user name to use when connecting to the server.

       •   --verbose[=0|1|2|3|4]

           Activate verbose output to the console and specify the level of detail. The value is
           an integer in the range from 0 to 4. 0 displays no messages, which is the default
           verbosity setting when you do not specify the option. 1 displays error, warning and
           informational messages (this is the default setting if you specify the option on the
           command line without a value). 2, 3, and 4 add higher levels of debug messages. See
           Chapter 12, MySQL Shell Logging and Debug for more information.

       •   --version, -V

           Display the version of MySQL Shell and exit.

       •   --vertical, -E

           Display results vertically, as when the \G terminator is used for an SQL query. This
           option is an alias of the --result-format=vertical option.

COPYRIGHT

       Copyright © 2006, 2023, Oracle and/or its affiliates.

       This documentation is free software; you can redistribute it and/or modify it only under
       the terms of the GNU General Public License as published by the Free Software Foundation;
       version 2 of the License.

       This documentation is distributed in the hope that it will be useful, but WITHOUT ANY
       WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE. See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with the program;
       if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
       Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.

NOTES

        1. Using MySQL as a Document Store
           https://dev.mysql.com/doc/refman/8.0/en/document-store.html

        2. Using X Plugin with the Caching SHA-2 Authentication Plugin
           https://dev.mysql.com/doc/refman/8.0/en/x-plugin-sha2-cache-plugin.html

        3. FIDO Pluggable Authentication
           https://dev.mysql.com/doc/refman/8.0/en/fido-pluggable-authentication.html

        4. Caching SHA-2 Pluggable Authentication
           https://dev.mysql.com/doc/refman/8.0/en/caching-sha2-pluggable-authentication.html

        5. Available Authentication Plugins
           https://dev.mysql.com/doc/refman/8.0/en/pluggable-authentication.html#pluggable-authentication-available-plugins

        6. End-User Guidelines for Password Security
           https://dev.mysql.com/doc/refman/8.0/en/password-security-user.html

        7. MySQL Shell Ports
           https://dev.mysql.com/doc/mysql-port-reference/en/mysql-port-reference-tables.html#GUID-65C1FF7E-5357-4E58-8D68-A0C3D24C0832__MYSQL-SHELL-PORTS

        8. Command Options for Encrypted Connections
           https://dev.mysql.com/doc/refman/8.0/en/connection-options.html#encrypted-connection-options

        9. Connecting to the Server Using URI-Like Strings or Key-Value Pairs
           https://dev.mysql.com/doc/refman/8.0/en/connecting-using-uri-or-key-value-pairs.html

AUTHOR

       Oracle Corporation (http://dev.mysql.com/).