1MYSQL(1)                     MySQL Database System                    MYSQL(1)
2
3
4

NAME

6       mysql - the MySQL command-line client
7

SYNOPSIS

9       mysql [options] db_name
10

DESCRIPTION

12       mysql is a simple SQL shell with input line editing capabilities. It
13       supports interactive and noninteractive use. When used interactively,
14       query results are presented in an ASCII-table format. When used
15       noninteractively (for example, as a filter), the result is presented in
16       tab-separated format. The output format can be changed using command
17       options.
18
19       If you have problems due to insufficient memory for large result sets,
20       use the --quick option. This forces mysql to retrieve results from the
21       server a row at a time rather than retrieving the entire result set and
22       buffering it in memory before displaying it. This is done by returning
23       the result set using the mysql_use_result() C API function in the
24       client/server library rather than mysql_store_result().
25
26           Note
27           Alternatively, MySQL Shell offers access to the X DevAPI. For
28           details, see MySQL Shell 8.0[1].
29
30       Using mysql is very easy. Invoke it from the prompt of your command
31       interpreter as follows:
32
33           mysql db_name
34
35       Or:
36
37           mysql --user=user_name --password db_name
38
39       In this case, you'll need to enter your password in response to the
40       prompt that mysql displays:
41
42           Enter password: your_password
43
44       Then type an SQL statement, end it with ;, \g, or \G and press Enter.
45
46       Typing Control+C interrupts the current statement if there is one, or
47       cancels any partial input line otherwise.
48
49       You can execute SQL statements in a script file (batch file) like this:
50
51           mysql db_name < script.sql > output.tab
52
53       On Unix, the mysql client logs statements executed interactively to a
54       history file. See the section called “MYSQL CLIENT LOGGING”.
55

MYSQL CLIENT OPTIONS

57       mysql supports the following options, which can be specified on the
58       command line or in the [mysql] and [client] groups of an option file.
59       For information about option files used by MySQL programs, see
60       Section 4.2.2.2, “Using Option Files”.
61
62--help, -?  Display a help message and exit.
63
64--auto-rehash Enable automatic rehashing. This option is on by
65           default, which enables database, table, and column name completion.
66           Use --disable-auto-rehash to disable rehashing. That causes mysql
67           to start faster, but you must issue the rehash command or its \#
68           shortcut if you want to use name completion.
69
70           To complete a name, enter the first part and press Tab. If the name
71           is unambiguous, mysql completes it. Otherwise, you can press Tab
72           again to see the possible names that begin with what you have typed
73           so far. Completion does not occur if there is no default database.
74
75               Note
76               This feature requires a MySQL client that is compiled with the
77               readline library. Typically, the readline library is not
78               available on Windows.
79
80--auto-vertical-output Cause result sets to be displayed vertically
81           if they are too wide for the current window, and using normal
82           tabular format otherwise. (This applies to statements terminated by
83           ; or \G.)
84
85--batch, -B Print results using tab as the column separator, with
86           each row on a new line. With this option, mysql does not use the
87           history file.
88
89           Batch mode results in nontabular output format and escaping of
90           special characters. Escaping may be disabled by using raw mode; see
91           the description for the --raw option.
92
93--binary-as-hex When this option is given, mysql displays binary
94           data using hexadecimal notation (0xvalue). This occurs whether the
95           overall output display format is tabular, vertical, HTML, or XML.
96
97           --binary-as-hex when enabled affects display of all binary strings,
98           including those returned by functions such as CHAR() and UNHEX().
99           The following example demonstrates this using the ASCII code for A
100           (65 decimal, 41 hexadecimal):
101
102--binary-as-hex disabled:
103
104                   mysql> SELECT CHAR(0x41), UNHEX('41');
105                   +------------+-------------+
106                   | CHAR(0x41) | UNHEX('41') |
107                   +------------+-------------+
108                   | A          | A           |
109                   +------------+-------------+
110
111--binary-as-hex enabled:
112
113                   mysql> SELECT CHAR(0x41), UNHEX('41');
114                   +------------------------+--------------------------+
115                   | CHAR(0x41)             | UNHEX('41')              |
116                   +------------------------+--------------------------+
117                   | 0x41                   | 0x41                     |
118                   +------------------------+--------------------------+
119
120           To write a binary string expression so that it displays as a
121           character string regardless of whether --binary-as-hex is enabled,
122           use these techniques:
123
124           •   The CHAR() function has a USING charset clause:
125
126                   mysql> SELECT CHAR(0x41 USING utf8mb4);
127                   +--------------------------+
128                   | CHAR(0x41 USING utf8mb4) |
129                   +--------------------------+
130                   | A                        |
131                   +--------------------------+
132
133           •   More generally, use CONVERT() to convert an expression to a
134               given character set:
135
136                   mysql> SELECT CONVERT(UNHEX('41') USING utf8mb4);
137                   +------------------------------------+
138                   | CONVERT(UNHEX('41') USING utf8mb4) |
139                   +------------------------------------+
140                   | A                                  |
141                   +------------------------------------+
142
143           As of MySQL 8.0.19, when mysql operates in interactive mode, this
144           option is enabled by default. In addition, output from the status
145           (or \s) command includes this line when the option is enabled
146           implicitly or explicitly:
147
148               Binary data as: Hexadecimal
149
150           To disable hexadecimal notation, use --skip-binary-as-hex
151
152--binary-mode This option helps when processing mysqlbinlog output
153           that may contain BLOB values. By default, mysql translates \r\n in
154           statement strings to \n and interprets \0 as the statement
155           terminator.  --binary-mode disables both features. It also disables
156           all mysql commands except charset and delimiter in noninteractive
157           mode (for input piped to mysql or loaded using the source command).
158
159--bind-address=ip_address On a computer having multiple network
160           interfaces, use this option to select which interface to use for
161           connecting to the MySQL server.
162
163--character-sets-dir=dir_name The directory where character sets
164           are installed. See Section 10.15, “Character Set Configuration”.
165
166--column-names Write column names in results.
167
168--column-type-info Display result set metadata. This information
169           corresponds to the contents of C API MYSQL_FIELD data structures.
170           See C API Basic Data Structures[2].
171
172--comments, -c Whether to strip or preserve comments in statements
173           sent to the server. The default is --skip-comments (strip
174           comments), enable with --comments (preserve comments).
175
176               Note
177               The mysql client always passes optimizer hints to the server,
178               regardless of whether this option is given.
179
180               Comment stripping is deprecated. Expect this feature and the
181               options to control it to be removed in a future MySQL release.
182
183--compress, -C Compress all information sent between the client and
184           the server if possible. See Section 4.2.8, “Connection Compression
185           Control”.
186
187           As of MySQL 8.0.18, this option is deprecated. Expect it be removed
188           in a future version of MySQL. See the section called “Configuring
189           Legacy Connection Compression”.
190
191--compression-algorithms=value The permitted compression algorithms
192           for connections to the server. The available algorithms are the
193           same as for the protocol_compression_algorithms system variable.
194           The default value is uncompressed.
195
196           For more information, see Section 4.2.8, “Connection Compression
197           Control”.
198
199           This option was added in MySQL 8.0.18.
200
201--connect-expired-password Indicate to the server that the client
202           can handle sandbox mode if the account used to connect has an
203           expired password. This can be useful for noninteractive invocations
204           of mysql because normally the server disconnects noninteractive
205           clients that attempt to connect using an account with an expired
206           password. (See Section 6.2.16, “Server Handling of Expired
207           Passwords”.)
208
209--connect-timeout=value The number of seconds before connection
210           timeout. (Default value is 0.)
211
212--database=db_name, -D db_name The database to use. This is useful
213           primarily in an option file.
214
215--debug[=debug_options], -# [debug_options] Write a debugging log.
216           A typical debug_options string is d:t:o,file_name. The default is
217           d:t:o,/tmp/mysql.trace.
218
219           This option is available only if MySQL was built using WITH_DEBUG.
220           MySQL release binaries provided by Oracle are not built using this
221           option.
222
223--debug-check Print some debugging information when the program
224           exits.
225
226           This option is available only if MySQL was built using WITH_DEBUG.
227           MySQL release binaries provided by Oracle are not built using this
228           option.
229
230--debug-info, -T Print debugging information and memory and CPU
231           usage statistics when the program exits.
232
233           This option is available only if MySQL was built using WITH_DEBUG.
234           MySQL release binaries provided by Oracle are not built using this
235           option.
236
237--default-auth=plugin A hint about which client-side authentication
238           plugin to use. See Section 6.2.17, “Pluggable Authentication”.
239
240--default-character-set=charset_name Use charset_name as the
241           default character set for the client and connection.
242
243           This option can be useful if the operating system uses one
244           character set and the mysql client by default uses another. In this
245           case, output may be formatted incorrectly. You can usually fix such
246           issues by using this option to force the client to use the system
247           character set instead.
248
249           For more information, see Section 10.4, “Connection Character Sets
250           and Collations”, and Section 10.15, “Character Set Configuration”.
251
252--defaults-extra-file=file_name Read this option file after the
253           global option file but (on Unix) before the user option file. If
254           the file does not exist or is otherwise inaccessible, an error
255           occurs. If file_name is not an absolute path name, it is
256           interpreted relative to the current directory.
257
258           For additional information about this and other option-file
259           options, see Section 4.2.2.3, “Command-Line Options that Affect
260           Option-File Handling”.
261
262--defaults-file=file_name Use only the given option file. If the
263           file does not exist or is otherwise inaccessible, an error occurs.
264           If file_name is not an absolute path name, it is interpreted
265           relative to the current directory.
266
267           Exception: Even with --defaults-file, client programs read
268           .mylogin.cnf.
269
270           For additional information about this and other option-file
271           options, see Section 4.2.2.3, “Command-Line Options that Affect
272           Option-File Handling”.
273
274--defaults-group-suffix=str Read not only the usual option groups,
275           but also groups with the usual names and a suffix of str. For
276           example, mysql normally reads the [client] and [mysql] groups. If
277           this option is given as --defaults-group-suffix=_other, mysql also
278           reads the [client_other] and [mysql_other] groups.
279
280           For additional information about this and other option-file
281           options, see Section 4.2.2.3, “Command-Line Options that Affect
282           Option-File Handling”.
283
284--delimiter=str Set the statement delimiter. The default is the
285           semicolon character (;).
286
287--disable-named-commands Disable named commands. Use the \* form
288           only, or use named commands only at the beginning of a line ending
289           with a semicolon (;).  mysql starts with this option enabled by
290           default. However, even with this option, long-format commands still
291           work from the first line. See the section called “MYSQL CLIENT
292           COMMANDS”.
293
294--dns-srv-name=name Specifies the name of a DNS SRV record that
295           determines the candidate hosts to use for establishing a connection
296           to a MySQL server. For information about DNS SRV support in MySQL,
297           see Section 4.2.6, “Connecting to the Server Using DNS SRV
298           Records”.
299
300           Suppose that DNS is configured with this SRV information for the
301           example.com domain:
302
303               Name                     TTL   Class   Priority Weight Port Target
304               _mysql._tcp.example.com. 86400 IN SRV  0        5      3306 host1.example.com
305               _mysql._tcp.example.com. 86400 IN SRV  0        10     3306 host2.example.com
306               _mysql._tcp.example.com. 86400 IN SRV  10       5      3306 host3.example.com
307               _mysql._tcp.example.com. 86400 IN SRV  20       5      3306 host4.example.com
308
309           To use that DNS SRV record, invoke mysql like this:
310
311               mysql --dns-srv-name=_mysql._tcp.example.com
312
313           mysql then attempts a connection to each server in the group until
314           a successful connection is established. A failure to connect occurs
315           only if a connection cannot be established to any of the servers.
316           The priority and weight values in the DNS SRV record determine the
317           order in which servers should be tried.
318
319           When invoked with --dns-srv-name, mysql attempts to establish TCP
320           connections only.
321
322           The --dns-srv-name option takes precedence over the --host option
323           if both are given.  --dns-srv-name causes connection establishment
324           to use the mysql_real_connect_dns_srv() C API function rather than
325           mysql_real_connect(). However, if the connect command is
326           subsequently used at runtime and specifies a host name argument,
327           that host name takes precedence over any --dns-srv-name option
328           given at mysql startup to specify a DNS SRV record.
329
330           This option was added in MySQL 8.0.22.
331
332--enable-cleartext-plugin Enable the mysql_clear_password cleartext
333           authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext
334           Pluggable Authentication”.)
335
336--execute=statement, -e statement Execute the statement and quit.
337           The default output format is like that produced with --batch. See
338           Section 4.2.2.1, “Using Options on the Command Line”, for some
339           examples. With this option, mysql does not use the history file.
340
341--fido-register-factor=value The factor or factors for which FIDO
342           device registration must be performed. This option value must be a
343           single value, or two values separated by commas. Each value must be
344           2 or 3, so the permitted option values are '2', '3', '2,3' and
345           '3,2'.
346
347           For example, an account that requires registration for a 3rd
348           authentication factor invokes the mysql client as follows:
349
350               mysql --user=user_name --fido-register-factor=3
351
352           An account that requires registration for a 2nd and 3rd
353           authentication factor invokes the mysql client as follows:
354
355               mysql --user=user_name --fido-register-factor=2,3
356
357           If registration is successful, a connection is established. If
358           there is an authentication factor with a pending registration, a
359           connection is placed into pending registration mode when attempting
360           to connect to the server. In this case, disconnect and reconnect
361           with the correct --fido-register-factor value to complete the
362           registration.
363
364           Registration is a two step process comprising initiate registration
365           and finish registration steps. The initiate registration step
366           executes this statement:
367
368               ALTER USER user factor INITIATE REGISTRATION
369
370           The statement returns a result set containing a 32 byte challenge,
371           the user name, and the relying party ID (see
372           authentication_fido_rp_id).
373
374           The finish registration step executes this statement:
375
376               ALTER USER user factor FINISH REGISTRATION SET CHALLENGE_RESPONSE AS 'auth_string'
377
378           The statement completes the registration and sends the following
379           information to the server as part of the auth_string: authenticator
380           data, an optional attestation certificate in X.509 format, and a
381           signature.
382
383           The initiate and registration steps must be performed in a single
384           connection, as the challenge received by the client during the
385           initiate step is saved to the client connection handler.
386           Registration would fail if the registration step was performed by a
387           different connection. The --fido-register-factor option executes
388           both the initiate and registration steps, which avoids the failure
389           scenario described above and prevents having to execute the ALTER
390           USER initiate and registration statements manually.
391
392           The --fido-register-factor option is only available for the mysql
393           client and MySQL Shell. Other MySQL client programs do not support
394           it.
395
396           For related information, see the section called “Using FIDO
397           Authentication”.
398
399--force, -f Continue even if an SQL error occurs.
400
401--get-server-public-key Request from the server the public key
402           required for RSA key pair-based password exchange. This option
403           applies to clients that authenticate with the caching_sha2_password
404           authentication plugin. For that plugin, the server does not send
405           the public key unless requested. This option is ignored for
406           accounts that do not authenticate with that plugin. It is also
407           ignored if RSA-based password exchange is not used, as is the case
408           when the client connects to the server using a secure connection.
409
410           If --server-public-key-path=file_name is given and specifies a
411           valid public key file, it takes precedence over
412           --get-server-public-key.
413
414           For information about the caching_sha2_password plugin, see
415           Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
416
417--histignore A list of one or more colon-separated patterns
418           specifying statements to ignore for logging purposes. These
419           patterns are added to the default pattern list
420           ("*IDENTIFIED*:*PASSWORD*"). The value specified for this option
421           affects logging of statements written to the history file, and to
422           syslog if the --syslog option is given. For more information, see
423           the section called “MYSQL CLIENT LOGGING”.
424
425--host=host_name, -h host_name Connect to the MySQL server on the
426           given host.
427
428           The --dns-srv-name option takes precedence over the --host option
429           if both are given.  --dns-srv-name causes connection establishment
430           to use the mysql_real_connect_dns_srv() C API function rather than
431           mysql_real_connect(). However, if the connect command is
432           subsequently used at runtime and specifies a host name argument,
433           that host name takes precedence over any --dns-srv-name option
434           given at mysql startup to specify a DNS SRV record.
435
436--html, -H Produce HTML output.
437
438--ignore-spaces, -i Ignore spaces after function names. The effect
439           of this is described in the discussion for the IGNORE_SPACE SQL
440           mode (see Section 5.1.11, “Server SQL Modes”).
441
442--init-command=str SQL statement to execute after connecting to the
443           server. If auto-reconnect is enabled, the statement is executed
444           again after reconnection occurs.
445
446--line-numbers Write line numbers for errors. Disable this with
447           --skip-line-numbers.
448
449--load-data-local-dir=dir_name This option affects the client-side
450           LOCAL capability for LOAD DATA operations. It specifies the
451           directory in which files named in LOAD DATA LOCAL statements must
452           be located. The effect of --load-data-local-dir depends on whether
453           LOCAL data loading is enabled or disabled:
454
455           •   If LOCAL data loading is enabled, either by default in the
456               MySQL client library or by specifying --local-infile[=1], the
457               --load-data-local-dir option is ignored.
458
459           •   If LOCAL data loading is disabled, either by default in the
460               MySQL client library or by specifying --local-infile=0, the
461               --load-data-local-dir option applies.
462
463           When --load-data-local-dir applies, the option value designates the
464           directory in which local data files must be located. Comparison of
465           the directory path name and the path name of files to be loaded is
466           case-sensitive regardless of the case sensitivity of the underlying
467           file system. If the option value is the empty string, it names no
468           directory, with the result that no files are permitted for local
469           data loading.
470
471           For example, to explicitly disable local data loading except for
472           files located in the /my/local/data directory, invoke mysql like
473           this:
474
475               mysql --local-infile=0 --load-data-local-dir=/my/local/data
476
477           When both --local-infile and --load-data-local-dir are given, the
478           order in which they are given does not matter.
479
480           Successful use of LOCAL load operations within mysql also requires
481           that the server permits local loading; see Section 6.1.6, “Security
482           Considerations for LOAD DATA LOCAL”
483
484           The --load-data-local-dir option was added in MySQL 8.0.21.
485
486--local-infile[={0|1}] By default, LOCAL capability for LOAD DATA
487           is determined by the default compiled into the MySQL client
488           library. To enable or disable LOCAL data loading explicitly, use
489           the --local-infile option. When given with no value, the option
490           enables LOCAL data loading. When given as --local-infile=0 or
491           --local-infile=1, the option disables or enables LOCAL data
492           loading.
493
494           If LOCAL capability is disabled, the --load-data-local-dir option
495           can be used to permit restricted local loading of files located in
496           a designated directory.
497
498           Successful use of LOCAL load operations within mysql also requires
499           that the server permits local loading; see Section 6.1.6, “Security
500           Considerations for LOAD DATA LOCAL”
501
502--login-path=name Read options from the named login path in the
503           .mylogin.cnf login path file. A “login path” is an option group
504           containing options that specify which MySQL server to connect to
505           and which account to authenticate as. To create or modify a login
506           path file, use the mysql_config_editor utility. See
507           mysql_config_editor(1).
508
509           For additional information about this and other option-file
510           options, see Section 4.2.2.3, “Command-Line Options that Affect
511           Option-File Handling”.
512
513--max-allowed-packet=value The maximum size of the buffer for
514           client/server communication. The default is 16MB, the maximum is
515           1GB.
516
517--max-join-size=value The automatic limit for rows in a join when
518           using --safe-updates. (Default value is 1,000,000.)
519
520--named-commands, -G Enable named mysql commands. Long-format
521           commands are permitted, not just short-format commands. For
522           example, quit and \q both are recognized. Use --skip-named-commands
523           to disable named commands. See the section called “MYSQL CLIENT
524           COMMANDS”.
525
526--net-buffer-length=value The buffer size for TCP/IP and socket
527           communication. (Default value is 16KB.)
528
529--network-namespace=name The network namespace to use for TCP/IP
530           connections. If omitted, the connection uses the default (global)
531           namespace. For information about network namespaces, see
532           Section 5.1.14, “Network Namespace Support”.
533
534           This option was added in MySQL 8.0.22. It is available only on
535           platforms that implement network namespace support.
536
537--no-auto-rehash, -A This has the same effect as
538           --skip-auto-rehash. See the description for --auto-rehash.
539
540--no-beep, -b Do not beep when errors occur.
541
542--no-defaults Do not read any option files. If program startup
543           fails due to reading unknown options from an option file,
544           --no-defaults can be used to prevent them from being read.
545
546           The exception is that the .mylogin.cnf file is read in all cases,
547           if it exists. This permits passwords to be specified in a safer way
548           than on the command line even when --no-defaults is used. To create
549           .mylogin.cnf, use the mysql_config_editor utility. See
550           mysql_config_editor(1).
551
552           For additional information about this and other option-file
553           options, see Section 4.2.2.3, “Command-Line Options that Affect
554           Option-File Handling”.
555
556--one-database, -o Ignore statements except those that occur while
557           the default database is the one named on the command line. This
558           option is rudimentary and should be used with care. Statement
559           filtering is based only on USE statements.
560
561           Initially, mysql executes statements in the input because
562           specifying a database db_name on the command line is equivalent to
563           inserting USE db_name at the beginning of the input. Then, for each
564           USE statement encountered, mysql accepts or rejects following
565           statements depending on whether the database named is the one on
566           the command line. The content of the statements is immaterial.
567
568           Suppose that mysql is invoked to process this set of statements:
569
570               DELETE FROM db2.t2;
571               USE db2;
572               DROP TABLE db1.t1;
573               CREATE TABLE db1.t1 (i INT);
574               USE db1;
575               INSERT INTO t1 (i) VALUES(1);
576               CREATE TABLE db2.t1 (j INT);
577
578           If the command line is mysql --force --one-database db1, mysql
579           handles the input as follows:
580
581           •   The DELETE statement is executed because the default database
582               is db1, even though the statement names a table in a different
583               database.
584
585           •   The DROP TABLE and CREATE TABLE statements are not executed
586               because the default database is not db1, even though the
587               statements name a table in db1.
588
589           •   The INSERT and CREATE TABLE statements are executed because the
590               default database is db1, even though the CREATE TABLE statement
591               names a table in a different database.
592
593--pager[=command] Use the given command for paging query output. If
594           the command is omitted, the default pager is the value of your
595           PAGER environment variable. Valid pagers are less, more, cat [>
596           filename], and so forth. This option works only on Unix and only in
597           interactive mode. To disable paging, use --skip-pager.  the section
598           called “MYSQL CLIENT COMMANDS”, discusses output paging further.
599
600--password[=password], -p[password] The password of the MySQL
601           account used for connecting to the server. The password value is
602           optional. If not given, mysql prompts for one. If given, there must
603           be no space between --password= or -p and the password following
604           it. If no password option is specified, the default is to send no
605           password.
606
607           Specifying a password on the command line should be considered
608           insecure. To avoid giving the password on the command line, use an
609           option file. See Section 6.1.2.1, “End-User Guidelines for Password
610           Security”.
611
612           To explicitly specify that there is no password and that mysql
613           should not prompt for one, use the --skip-password option.
614
615--password1[=pass_val] The password for multifactor authentication
616           factor 1 of the MySQL account used for connecting to the server.
617           The password value is optional. If not given, mysql prompts for
618           one. If given, there must be no space between --password1= and the
619           password following it. If no password option is specified, the
620           default is to send no password.
621
622           Specifying a password on the command line should be considered
623           insecure. To avoid giving the password on the command line, use an
624           option file. See Section 6.1.2.1, “End-User Guidelines for Password
625           Security”.
626
627           To explicitly specify that there is no password and that mysql
628           should not prompt for one, use the --skip-password1 option.
629
630           --password1 and --password are synonymous, as are --skip-password1
631           and --skip-password.
632
633--password2[=pass_val] The password for multifactor authentication
634           factor 2 of the MySQL account used for connecting to the server.
635           The semantics of this option are similar to the semantics for
636           --password1; see the description of that option for details.
637
638--password3[=pass_val] The password for multifactor authentication
639           factor 3 of the MySQL account used for connecting to the server.
640           The semantics of this option are similar to the semantics for
641           --password1; see the description of that option for details.
642
643--pipe, -W On Windows, connect to the server using a named pipe.
644           This option applies only if the server was started with the
645           named_pipe system variable enabled to support named-pipe
646           connections. In addition, the user making the connection must be a
647           member of the Windows group specified by the
648           named_pipe_full_access_group system variable.
649
650--plugin-dir=dir_name The directory in which to look for plugins.
651           Specify this option if the --default-auth option is used to specify
652           an authentication plugin but mysql does not find it. See
653           Section 6.2.17, “Pluggable Authentication”.
654
655--port=port_num, -P port_num For TCP/IP connections, the port
656           number to use.
657
658--print-defaults Print the program name and all options that it
659           gets from option files.
660
661           For additional information about this and other option-file
662           options, see Section 4.2.2.3, “Command-Line Options that Affect
663           Option-File Handling”.
664
665--prompt=format_str Set the prompt to the specified format. The
666           default is mysql>. The special sequences that the prompt can
667           contain are described in the section called “MYSQL CLIENT
668           COMMANDS”.
669
670--protocol={TCP|SOCKET|PIPE|MEMORY} The transport protocol to use
671           for connecting to the server. It is useful when the other
672           connection parameters normally result in use of a protocol other
673           than the one you want. For details on the permissible values, see
674           Section 4.2.7, “Connection Transport Protocols”.
675
676--quick, -q Do not cache each query result, print each row as it is
677           received. This may slow down the server if the output is suspended.
678           With this option, mysql does not use the history file.
679
680--raw, -r For tabular output, the “boxing” around columns enables
681           one column value to be distinguished from another. For nontabular
682           output (such as is produced in batch mode or when the --batch or
683           --silent option is given), special characters are escaped in the
684           output so they can be identified easily. Newline, tab, NUL, and
685           backslash are written as \n, \t, \0, and \\. The --raw option
686           disables this character escaping.
687
688           The following example demonstrates tabular versus nontabular output
689           and the use of raw mode to disable escaping:
690
691               % mysql
692               mysql> SELECT CHAR(92);
693               +----------+
694               | CHAR(92) |
695               +----------+
696               | \        |
697               +----------+
698               % mysql -s
699               mysql> SELECT CHAR(92);
700               CHAR(92)
701               \\
702               % mysql -s -r
703               mysql> SELECT CHAR(92);
704               CHAR(92)
705               \
706
707--reconnect If the connection to the server is lost, automatically
708           try to reconnect. A single reconnect attempt is made each time the
709           connection is lost. To suppress reconnection behavior, use
710           --skip-reconnect.
711
712--safe-updates, --i-am-a-dummy, -U If this option is enabled,
713           UPDATE and DELETE statements that do not use a key in the WHERE
714           clause or a LIMIT clause produce an error. In addition,
715           restrictions are placed on SELECT statements that produce (or are
716           estimated to produce) very large result sets. If you have set this
717           option in an option file, you can use --skip-safe-updates on the
718           command line to override it. For more information about this
719           option, see Using Safe-Updates Mode (--safe-updates).
720
721--select-limit=value The automatic limit for SELECT statements when
722           using --safe-updates. (Default value is 1,000.)
723
724--server-public-key-path=file_name The path name to a file in PEM
725           format containing a client-side copy of the public key required by
726           the server for RSA key pair-based password exchange. This option
727           applies to clients that authenticate with the sha256_password or
728           caching_sha2_password authentication plugin. This option is ignored
729           for accounts that do not authenticate with one of those plugins. It
730           is also ignored if RSA-based password exchange is not used, as is
731           the case when the client connects to the server using a secure
732           connection.
733
734           If --server-public-key-path=file_name is given and specifies a
735           valid public key file, it takes precedence over
736           --get-server-public-key.
737
738           For sha256_password, this option applies only if MySQL was built
739           using OpenSSL.
740
741           For information about the sha256_password and caching_sha2_password
742           plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”,
743           and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
744
745--shared-memory-base-name=name On Windows, the shared-memory name
746           to use for connections made using shared memory to a local server.
747           The default value is MYSQL. The shared-memory name is
748           case-sensitive.
749
750           This option applies only if the server was started with the
751           shared_memory system variable enabled to support shared-memory
752           connections.
753
754--show-warnings Cause warnings to be shown after each statement if
755           there are any. This option applies to interactive and batch mode.
756
757--sigint-ignore Ignore SIGINT signals (typically the result of
758           typing Control+C).
759
760           Without this option, typing Control+C interrupts the current
761           statement if there is one, or cancels any partial input line
762           otherwise.
763
764--silent, -s Silent mode. Produce less output. This option can be
765           given multiple times to produce less and less output.
766
767           This option results in nontabular output format and escaping of
768           special characters. Escaping may be disabled by using raw mode; see
769           the description for the --raw option.
770
771--skip-column-names, -N Do not write column names in results.
772
773--skip-line-numbers, -L Do not write line numbers for errors.
774           Useful when you want to compare result files that include error
775           messages.
776
777--socket=path, -S path For connections to localhost, the Unix
778           socket file to use, or, on Windows, the name of the named pipe to
779           use.
780
781           On Windows, this option applies only if the server was started with
782           the named_pipe system variable enabled to support named-pipe
783           connections. In addition, the user making the connection must be a
784           member of the Windows group specified by the
785           named_pipe_full_access_group system variable.
786
787--ssl* Options that begin with --ssl specify whether to connect to
788           the server using encryption and indicate where to find SSL keys and
789           certificates. See the section called “Command Options for Encrypted
790           Connections”.
791
792--ssl-fips-mode={OFF|ON|STRICT} Controls whether to enable FIPS
793           mode on the client side. The --ssl-fips-mode option differs from
794           other --ssl-xxx options in that it is not used to establish
795           encrypted connections, but rather to affect which cryptographic
796           operations to permit. See Section 6.8, “FIPS Support”.
797
798           These --ssl-fips-mode values are permitted:
799
800           •   OFF: Disable FIPS mode.
801
802           •   ON: Enable FIPS mode.
803
804           •   STRICT: Enable “strict” FIPS mode.
805
806
807               Note
808               If the OpenSSL FIPS Object Module is not available, the only
809               permitted value for --ssl-fips-mode is OFF. In this case,
810               setting --ssl-fips-mode to ON or STRICT causes the client to
811               produce a warning at startup and to operate in non-FIPS mode.
812
813--syslog, -j This option causes mysql to send interactive
814           statements to the system logging facility. On Unix, this is syslog;
815           on Windows, it is the Windows Event Log. The destination where
816           logged messages appear is system dependent. On Linux, the
817           destination is often the /var/log/messages file.
818
819           Here is a sample of output generated on Linux by using --syslog.
820           This output is formatted for readability; each logged message
821           actually takes a single line.
822
823               Mar  7 12:39:25 myhost MysqlClient[20824]:
824                 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
825                 DB_SERVER:'127.0.0.1', DB:'--', QUERY:'USE test;'
826               Mar  7 12:39:28 myhost MysqlClient[20824]:
827                 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
828                 DB_SERVER:'127.0.0.1', DB:'test', QUERY:'SHOW TABLES;'
829
830           For more information, see the section called “MYSQL CLIENT
831           LOGGING”.
832
833--table, -t Display output in table format. This is the default for
834           interactive use, but can be used to produce table output in batch
835           mode.
836
837--tee=file_name Append a copy of output to the given file. This
838           option works only in interactive mode.  the section called “MYSQL
839           CLIENT COMMANDS”, discusses tee files further.
840
841--tls-ciphersuites=ciphersuite_list The permissible ciphersuites
842           for encrypted connections that use TLSv1.3. The value is a list of
843           one or more colon-separated ciphersuite names. The ciphersuites
844           that can be named for this option depend on the SSL library used to
845           compile MySQL. For details, see Section 6.3.2, “Encrypted
846           Connection TLS Protocols and Ciphers”.
847
848           This option was added in MySQL 8.0.16.
849
850--tls-version=protocol_list The permissible TLS protocols for
851           encrypted connections. The value is a list of one or more
852           comma-separated protocol names. The protocols that can be named for
853           this option depend on the SSL library used to compile MySQL. For
854           details, see Section 6.3.2, “Encrypted Connection TLS Protocols and
855           Ciphers”.
856
857--unbuffered, -n Flush the buffer after each query.
858
859--user=user_name, -u user_name The user name of the MySQL account
860           to use for connecting to the server.
861
862--verbose, -v Verbose mode. Produce more output about what the
863           program does. This option can be given multiple times to produce
864           more and more output. (For example, -v -v -v produces table output
865           format even in batch mode.)
866
867--version, -V Display version information and exit.
868
869--vertical, -E Print query output rows vertically (one line per
870           column value). Without this option, you can specify vertical output
871           for individual statements by terminating them with \G.
872
873--wait, -w If the connection cannot be established, wait and retry
874           instead of aborting.
875
876--xml, -X Produce XML output.
877
878               <field name="column_name">NULL</field>
879
880           The output when --xml is used with mysql matches that of mysqldump
881           --xml. See mysqldump(1), for details.
882
883           The XML output also uses an XML namespace, as shown here:
884
885               $> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
886               <?xml version="1.0"?>
887               <resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
888               <row>
889               <field name="Variable_name">version</field>
890               <field name="Value">5.0.40-debug</field>
891               </row>
892               <row>
893               <field name="Variable_name">version_comment</field>
894               <field name="Value">Source distribution</field>
895               </row>
896               <row>
897               <field name="Variable_name">version_compile_machine</field>
898               <field name="Value">i686</field>
899               </row>
900               <row>
901               <field name="Variable_name">version_compile_os</field>
902               <field name="Value">suse-linux-gnu</field>
903               </row>
904               </resultset>
905
906--zstd-compression-level=level The compression level to use for
907           connections to the server that use the zstd compression algorithm.
908           The permitted levels are from 1 to 22, with larger values
909           indicating increasing levels of compression. The default zstd
910           compression level is 3. The compression level setting has no effect
911           on connections that do not use zstd compression.
912
913           For more information, see Section 4.2.8, “Connection Compression
914           Control”.
915
916           This option was added in MySQL 8.0.18.
917

MYSQL CLIENT COMMANDS

919       mysql sends each SQL statement that you issue to the server to be
920       executed. There is also a set of commands that mysql itself interprets.
921       For a list of these commands, type help or \h at the mysql> prompt:
922
923           mysql> help
924           List of all MySQL commands:
925           Note that all text commands must be first on line and end with ';'
926           ?         (\?) Synonym for `help'.
927           clear     (\c) Clear the current input statement.
928           connect   (\r) Reconnect to the server. Optional arguments are db and host.
929           delimiter (\d) Set statement delimiter.
930           edit      (\e) Edit command with $EDITOR.
931           ego       (\G) Send command to mysql server, display result vertically.
932           exit      (\q) Exit mysql. Same as quit.
933           go        (\g) Send command to mysql server.
934           help      (\h) Display this help.
935           nopager   (\n) Disable pager, print to stdout.
936           notee     (\t) Don't write into outfile.
937           pager     (\P) Set PAGER [to_pager]. Print the query results via PAGER.
938           print     (\p) Print current command.
939           prompt    (\R) Change your mysql prompt.
940           quit      (\q) Quit mysql.
941           rehash    (\#) Rebuild completion hash.
942           source    (\.) Execute an SQL script file. Takes a file name as an argument.
943           status    (\s) Get status information from the server.
944           system    (\!) Execute a system shell command.
945           tee       (\T) Set outfile [to_outfile]. Append everything into given
946                          outfile.
947           use       (\u) Use another database. Takes database name as argument.
948           charset   (\C) Switch to another charset. Might be needed for processing
949                          binlog with multi-byte charsets.
950           warnings  (\W) Show warnings after every statement.
951           nowarning (\w) Don't show warnings after every statement.
952           resetconnection(\x) Clean session context.
953           query_attributes Sets string parameters (name1 value1 name2 value2 ...)
954           for the next query to pick up.
955           ssl_session_data_print Serializes the current SSL session data to stdout
956           or file.
957           For server side help, type 'help contents'
958
959       If mysql is invoked with the --binary-mode option, all mysql commands
960       are disabled except charset and delimiter in noninteractive mode (for
961       input piped to mysql or loaded using the source command).
962
963       Each command has both a long and short form. The long form is not
964       case-sensitive; the short form is. The long form can be followed by an
965       optional semicolon terminator, but the short form should not.
966
967       The use of short-form commands within multiple-line /* ... */ comments
968       is not supported. Short-form commands do work within single-line /*!
969       ... */ version comments, as do /*+ ... */ optimizer-hint comments,
970       which are stored in object definitions. If there is a concern that
971       optimizer-hint comments may be stored in object definitions so that
972       dump files when reloaded with mysql would result in execution of such
973       commands, either invoke mysql with the --binary-mode option or use a
974       reload client other than mysql.
975
976       •   help [arg], \h [arg], \? [arg], ? [arg]
977
978           Display a help message listing the available mysql commands.
979
980           If you provide an argument to the help command, mysql uses it as a
981           search string to access server-side help from the contents of the
982           MySQL Reference Manual. For more information, see the section
983           called “MYSQL CLIENT SERVER-SIDE HELP”.
984
985       •   charset charset_name, \C charset_name
986
987           Change the default character set and issue a SET NAMES statement.
988           This enables the character set to remain synchronized on the client
989           and server if mysql is run with auto-reconnect enabled (which is
990           not recommended), because the specified character set is used for
991           reconnects.
992
993       •   clear, \c
994
995           Clear the current input. Use this if you change your mind about
996           executing the statement that you are entering.
997
998       •   connect [db_name [host_name]], \r [db_name [host_name]]
999
1000           Reconnect to the server. The optional database name and host name
1001           arguments may be given to specify the default database or the host
1002           where the server is running. If omitted, the current values are
1003           used.
1004
1005           If the connect command specifies a host name argument, that host
1006           takes precedence over any --dns-srv-name option given at mysql
1007           startup to specify a DNS SRV record.
1008
1009       •   delimiter str, \d str
1010
1011           Change the string that mysql interprets as the separator between
1012           SQL statements. The default is the semicolon character (;).
1013
1014           The delimiter string can be specified as an unquoted or quoted
1015           argument on the delimiter command line. Quoting can be done with
1016           either single quote ('), double quote ("), or backtick (`)
1017           characters. To include a quote within a quoted string, either quote
1018           the string with a different quote character or escape the quote
1019           with a backslash (\) character. Backslash should be avoided outside
1020           of quoted strings because it is the escape character for MySQL. For
1021           an unquoted argument, the delimiter is read up to the first space
1022           or end of line. For a quoted argument, the delimiter is read up to
1023           the matching quote on the line.
1024
1025           mysql interprets instances of the delimiter string as a statement
1026           delimiter anywhere it occurs, except within quoted strings. Be
1027           careful about defining a delimiter that might occur within other
1028           words. For example, if you define the delimiter as X, it is not
1029           possible to use the word INDEX in statements.  mysql interprets
1030           this as INDE followed by the delimiter X.
1031
1032           When the delimiter recognized by mysql is set to something other
1033           than the default of ;, instances of that character are sent to the
1034           server without interpretation. However, the server itself still
1035           interprets ; as a statement delimiter and processes statements
1036           accordingly. This behavior on the server side comes into play for
1037           multiple-statement execution (see Multiple Statement Execution
1038           Support[3]), and for parsing the body of stored procedures and
1039           functions, triggers, and events (see Section 25.1, “Defining Stored
1040           Programs”).
1041
1042       •   edit, \e
1043
1044           Edit the current input statement.  mysql checks the values of the
1045           EDITOR and VISUAL environment variables to determine which editor
1046           to use. The default editor is vi if neither variable is set.
1047
1048           The edit command works only in Unix.
1049
1050       •   ego, \G
1051
1052           Send the current statement to the server to be executed and display
1053           the result using vertical format.
1054
1055       •   exit, \q
1056
1057           Exit mysql.
1058
1059       •   go, \g
1060
1061           Send the current statement to the server to be executed.
1062
1063       •   nopager, \n
1064
1065           Disable output paging. See the description for pager.
1066
1067           The nopager command works only in Unix.
1068
1069       •   notee, \t
1070
1071           Disable output copying to the tee file. See the description for
1072           tee.
1073
1074       •   nowarning, \w
1075
1076           Disable display of warnings after each statement.
1077
1078       •   pager [command], \P [command]
1079
1080           Enable output paging. By using the --pager option when you invoke
1081           mysql, it is possible to browse or search query results in
1082           interactive mode with Unix programs such as less, more, or any
1083           other similar program. If you specify no value for the option,
1084           mysql checks the value of the PAGER environment variable and sets
1085           the pager to that. Pager functionality works only in interactive
1086           mode.
1087
1088           Output paging can be enabled interactively with the pager command
1089           and disabled with nopager. The command takes an optional argument;
1090           if given, the paging program is set to that. With no argument, the
1091           pager is set to the pager that was set on the command line, or
1092           stdout if no pager was specified.
1093
1094           Output paging works only in Unix because it uses the popen()
1095           function, which does not exist on Windows. For Windows, the tee
1096           option can be used instead to save query output, although it is not
1097           as convenient as pager for browsing output in some situations.
1098
1099       •   print, \p
1100
1101           Print the current input statement without executing it.
1102
1103       •   prompt [str], \R [str]
1104
1105           Reconfigure the mysql prompt to the given string. The special
1106           character sequences that can be used in the prompt are described
1107           later in this section.
1108
1109           If you specify the prompt command with no argument, mysql resets
1110           the prompt to the default of mysql>.
1111
1112       •   query_attributes name value [name value ...]
1113
1114           Define query attributes that apply to the next query sent to the
1115           server. For discussion of the purpose and use of query attributes,
1116           see Section 9.6, “Query Attributes”.
1117
1118           The query_attributes command follows these rules:
1119
1120           •   The format and quoting rules for attribute names and values are
1121               the same as for the delimiter command.
1122
1123           •   The command permits up to 32 attribute name/value pairs. Names
1124               and values may be up to 1024 characters long. If a name is
1125               given without a value, an error occurs.
1126
1127           •   If multiple query_attributes commands are issued prior to query
1128               execution, only the last command applies. After sending the
1129               query, mysql clears the attribute set.
1130
1131           •   If multiple attributes are defined with the same name, attempts
1132               to retrieve the attribute value have an undefined result.
1133
1134           •   An attribute defined with an empty name cannot be retrieved by
1135               name.
1136
1137           •   If a reconnect occurs while mysql executes the query, mysql
1138               restores the attributes after reconnecting so the query can be
1139               executed again with the same attributes.
1140
1141
1142       •   quit, \q
1143
1144           Exit mysql.
1145
1146       •   rehash, \#
1147
1148           Rebuild the completion hash that enables database, table, and
1149           column name completion while you are entering statements. (See the
1150           description for the --auto-rehash option.)
1151
1152       •   resetconnection, \x
1153
1154           Reset the connection to clear the session state. This includes
1155           clearing any current query attributes defined using the
1156           query_attributes command.
1157
1158           Resetting a connection has effects similar to mysql_change_user()
1159           or an auto-reconnect except that the connection is not closed and
1160           reopened, and re-authentication is not done. See
1161           mysql_change_user()[4], and Automatic Reconnection Control[5].
1162
1163           This example shows how resetconnection clears a value maintained in
1164           the session state:
1165
1166               mysql> SELECT LAST_INSERT_ID(3);
1167               +-------------------+
1168               | LAST_INSERT_ID(3) |
1169               +-------------------+
1170               |                 3 |
1171               +-------------------+
1172               mysql> SELECT LAST_INSERT_ID();
1173               +------------------+
1174               | LAST_INSERT_ID() |
1175               +------------------+
1176               |                3 |
1177               +------------------+
1178               mysql> resetconnection;
1179               mysql> SELECT LAST_INSERT_ID();
1180               +------------------+
1181               | LAST_INSERT_ID() |
1182               +------------------+
1183               |                0 |
1184               +------------------+
1185
1186       •   source file_name, \. file_name
1187
1188           Read the named file and executes the statements contained therein.
1189           On Windows, specify path name separators as / or \\.
1190
1191           Quote characters are taken as part of the file name itself. For
1192           best results, the name should not include space characters.
1193
1194       •   ssl_session_data_print [file_name]
1195
1196           Fetches, serializes, and optionally stores the session data of a
1197           successful connection. The optional file name and arguments may be
1198           given to specify the file to store serialized session data. If
1199           omitted, the session data is printed to stdout.
1200
1201           If the MySQL session is configured for reuse, session data from the
1202           file is deserialized and supplied to the connect command to
1203           reconnect. When the session is reused successfully, the status
1204           command contains a row showing SSL session reused: true while the
1205           client remains reconnected to the server.
1206
1207       •   status, \s
1208
1209           Provide status information about the connection and the server you
1210           are using. If you are running with --safe-updates enabled, status
1211           also prints the values for the mysql variables that affect your
1212           queries.
1213
1214       •   system command, \! command
1215
1216           Execute the given command using your default command interpreter.
1217
1218           Prior to MySQL 8.0.19, the system command works only in Unix. As of
1219           8.0.19, it also works on Windows.
1220
1221       •   tee [file_name], \T [file_name]
1222
1223           By using the --tee option when you invoke mysql, you can log
1224           statements and their output. All the data displayed on the screen
1225           is appended into a given file. This can be very useful for
1226           debugging purposes also.  mysql flushes results to the file after
1227           each statement, just before it prints its next prompt. Tee
1228           functionality works only in interactive mode.
1229
1230           You can enable this feature interactively with the tee command.
1231           Without a parameter, the previous file is used. The tee file can be
1232           disabled with the notee command. Executing tee again re-enables
1233           logging.
1234
1235       •   use db_name, \u db_name
1236
1237           Use db_name as the default database.
1238
1239       •   warnings, \W
1240
1241           Enable display of warnings after each statement (if there are any).
1242
1243       Here are a few tips about the pager command:
1244
1245       •   You can use it to write to a file and the results go only to the
1246           file:
1247
1248               mysql> pager cat > /tmp/log.txt
1249
1250           You can also pass any options for the program that you want to use
1251           as your pager:
1252
1253               mysql> pager less -n -i -S
1254
1255       •   In the preceding example, note the -S option. You may find it very
1256           useful for browsing wide query results. Sometimes a very wide
1257           result set is difficult to read on the screen. The -S option to
1258           less can make the result set much more readable because you can
1259           scroll it horizontally using the left-arrow and right-arrow keys.
1260           You can also use -S interactively within less to switch the
1261           horizontal-browse mode on and off. For more information, read the
1262           less manual page:
1263
1264               man less
1265
1266       •   The -F and -X options may be used with less to cause it to exit if
1267           output fits on one screen, which is convenient when no scrolling is
1268           necessary:
1269
1270               mysql> pager less -n -i -S -F -X
1271
1272       •   You can specify very complex pager commands for handling query
1273           output:
1274
1275               mysql> pager cat | tee /dr1/tmp/res.txt \
1276                         | tee /dr2/tmp/res2.txt | less -n -i -S
1277
1278           In this example, the command would send query results to two files
1279           in two different directories on two different file systems mounted
1280           on /dr1 and /dr2, yet still display the results onscreen using
1281           less.
1282
1283       You can also combine the tee and pager functions. Have a tee file
1284       enabled and pager set to less, and you are able to browse the results
1285       using the less program and still have everything appended into a file
1286       the same time. The difference between the Unix tee used with the pager
1287       command and the mysql built-in tee command is that the built-in tee
1288       works even if you do not have the Unix tee available. The built-in tee
1289       also logs everything that is printed on the screen, whereas the Unix
1290       tee used with pager does not log quite that much. Additionally, tee
1291       file logging can be turned on and off interactively from within mysql.
1292       This is useful when you want to log some queries to a file, but not
1293       others.
1294
1295       The prompt command reconfigures the default mysql> prompt. The string
1296       for defining the prompt can contain the following special sequences.
1297
1298.br
1299.br
1300.br
130172
1302       ┌───────────────────────────┬────────────────────────────┐
1303Option                     Description                
1304       ├───────────────────────────┼────────────────────────────┤
1305       │                           │ The current connection     │
1306       │                           │ identifier                 │
1307       ├───────────────────────────┼────────────────────────────┤
1308       │                           │ A counter that increments  │
1309       │                           │ for each statement you     │
1310       │                           │ issue                      │
1311       ├───────────────────────────┼────────────────────────────┤
1312       │                           │ The full current date      │
1313       ├───────────────────────────┼────────────────────────────┤
1314       │                           │ The default database       │
1315       ├───────────────────────────┼────────────────────────────┤
1316       │                           │ The server host            │
1317       ├───────────────────────────┼────────────────────────────┤
1318       │                           │ The current delimiter      │
1319       ├───────────────────────────┼────────────────────────────┤
1320       │                           │ Minutes of the current     │
1321       │                           │ time                       │
1322       ├───────────────────────────┼────────────────────────────┤
1323       │                           │ A newline character        │
1324       ├───────────────────────────┼────────────────────────────┤
1325       │                           │ The current month in       │
1326       │                           │ three-letter format (Jan,  │
1327       │                           │ Feb, ...)                  │
1328       ├───────────────────────────┼────────────────────────────┤
1329       │                           │ The current month in       │
1330       │                           │ numeric format             │
1331       ├───────────────────────────┼────────────────────────────┤
1332       │P                          │ am/pm                      │
1333       ├───────────────────────────┼────────────────────────────┤
1334       │                           │ The current TCP/IP port or │
1335       │                           │ socket file                │
1336       ├───────────────────────────┼────────────────────────────┤
1337       │                           │ The current time, in       │
1338       │                           │ 24-hour military time      │
1339       │                           │ (0–23)                     │
1340       ├───────────────────────────┼────────────────────────────┤
1341       │                           │ The current time, standard │
1342       │                           │ 12-hour time (1–12)        │
1343       ├───────────────────────────┼────────────────────────────┤
1344       │                           │ Semicolon                  │
1345       ├───────────────────────────┼────────────────────────────┤
1346       │                           │ Seconds of the current     │
1347       │                           │ time                       │
1348       ├───────────────────────────┼────────────────────────────┤
1349       │T                          │ Print an asterisk (*) if   │
1350       │                           │ the current session is     │
1351       │                           │               inside a     │
1352       │                           │ transaction block (from    │
1353       │                           │ MySQL 8.0.28)              │
1354       ├───────────────────────────┼────────────────────────────┤
1355       │                           │ A tab character            │
1356       ├───────────────────────────┼────────────────────────────┤
1357       │U                          │                            │
1358       │                           │        Your full           │
1359       │                           │        user_name@host_name
1360       │                           │        account name        │
1361       ├───────────────────────────┼────────────────────────────┤
1362       │                           │ Your user name             │
1363       ├───────────────────────────┼────────────────────────────┤
1364       │                           │ The server version         │
1365       ├───────────────────────────┼────────────────────────────┤
1366       │                           │ The current day of the     │
1367       │                           │ week in three-letter       │
1368       │                           │ format (Mon, Tue, ...)     │
1369       ├───────────────────────────┼────────────────────────────┤
1370       │                           │ The current year, four     │
1371       │                           │ digits                     │
1372       ├───────────────────────────┼────────────────────────────┤
1373       │y                          │ The current year, two      │
1374       │                           │ digits                     │
1375       ├───────────────────────────┼────────────────────────────┤
1376       │_                          │ A space                    │
1377       ├───────────────────────────┼────────────────────────────┤
1378       │\                          │ A space (a space follows   │
1379       │                           │ the backslash)             │
1380       ├───────────────────────────┼────────────────────────────┤
1381       │´                          │ Single quote               │
1382       ├───────────────────────────┼────────────────────────────┤
1383       │                           │ Double quote               │
1384       ├───────────────────────────┼────────────────────────────┤
1385       │T}:T{ A literal  backslash │                            │
1386       │character                  │                            │
1387       ├───────────────────────────┼────────────────────────────┤
1388       │\fIx                       │                            │
1389       │                           │        x, for any “x” not  │
1390       │                           │        listed above        │
1391       └───────────────────────────┴────────────────────────────┘
1392
1393       You can set the prompt in several ways:
1394
1395Use an environment variable.  You can set the MYSQL_PS1 environment
1396           variable to a prompt string. For example:
1397
1398               export MYSQL_PS1="(\u@\h) [\d]> "
1399
1400Use a command-line option.  You can set the --prompt option on the
1401           command line to mysql. For example:
1402
1403               $> mysql --prompt="(\u@\h) [\d]> "
1404               (user@host) [database]>
1405
1406Use an option file.  You can set the prompt option in the [mysql]
1407           group of any MySQL option file, such as /etc/my.cnf or the .my.cnf
1408           file in your home directory. For example:
1409
1410               [mysql]
1411               prompt=(\\u@\\h) [\\d]>\\_
1412
1413           In this example, note that the backslashes are doubled. If you set
1414           the prompt using the prompt option in an option file, it is
1415           advisable to double the backslashes when using the special prompt
1416           options. There is some overlap in the set of permissible prompt
1417           options and the set of special escape sequences that are recognized
1418           in option files. (The rules for escape sequences in option files
1419           are listed in Section 4.2.2.2, “Using Option Files”.) The overlap
1420           may cause you problems if you use single backslashes. For example,
1421           \s is interpreted as a space rather than as the current seconds
1422           value. The following example shows how to define a prompt within an
1423           option file to include the current time in hh:mm:ss> format:
1424
1425               [mysql]
1426               prompt="\\r:\\m:\\s> "
1427
1428Set the prompt interactively.  You can change your prompt
1429           interactively by using the prompt (or \R) command. For example:
1430
1431               mysql> prompt (\u@\h) [\d]>\_
1432               PROMPT set to '(\u@\h) [\d]>\_'
1433               (user@host) [database]>
1434               (user@host) [database]> prompt
1435               Returning to default PROMPT of mysql>
1436               mysql>
1437

MYSQL CLIENT LOGGING

1439       The mysql client can do these types of logging for statements executed
1440       interactively:
1441
1442       •   On Unix, mysql writes the statements to a history file. By default,
1443           this file is named .mysql_history in your home directory. To
1444           specify a different file, set the value of the MYSQL_HISTFILE
1445           environment variable.
1446
1447       •   On all platforms, if the --syslog option is given, mysql writes the
1448           statements to the system logging facility. On Unix, this is syslog;
1449           on Windows, it is the Windows Event Log. The destination where
1450           logged messages appear is system dependent. On Linux, the
1451           destination is often the /var/log/messages file.
1452
1453       The following discussion describes characteristics that apply to all
1454       logging types and provides information specific to each logging type.
1455
1456       •   How Logging Occurs
1457
1458       •   Controlling the History File
1459
1460       •   syslog Logging Characteristics
1461       How Logging Occurs
1462
1463       For each enabled logging destination, statement logging occurs as
1464       follows:
1465
1466       •   Statements are logged only when executed interactively. Statements
1467           are noninteractive, for example, when read from a file or a pipe.
1468           It is also possible to suppress statement logging by using the
1469           --batch or --execute option.
1470
1471       •   Statements are ignored and not logged if they match any pattern in
1472           the “ignore” list. This list is described later.
1473
1474mysql logs each nonignored, nonempty statement line individually.
1475
1476       •   If a nonignored statement spans multiple lines (not including the
1477           terminating delimiter), mysql concatenates the lines to form the
1478           complete statement, maps newlines to spaces, and logs the result,
1479           plus a delimiter.
1480
1481       Consequently, an input statement that spans multiple lines can be
1482       logged twice. Consider this input:
1483
1484           mysql> SELECT
1485               -> 'Today is'
1486               -> ,
1487               -> CURDATE()
1488               -> ;
1489
1490       In this case, mysql logs the “SELECT”, “'Today is'”, “,”, “CURDATE()”,
1491       and “;” lines as it reads them. It also logs the complete statement,
1492       after mapping SELECT\n'Today is'\n,\nCURDATE() to SELECT 'Today is' ,
1493       CURDATE(), plus a delimiter. Thus, these lines appear in logged output:
1494
1495           SELECT
1496           'Today is'
1497           ,
1498           CURDATE()
1499           ;
1500           SELECT 'Today is' , CURDATE();
1501
1502       mysql ignores for logging purposes statements that match any pattern in
1503       the “ignore” list. By default, the pattern list is
1504       "*IDENTIFIED*:*PASSWORD*", to ignore statements that refer to
1505       passwords. Pattern matching is not case-sensitive. Within patterns, two
1506       characters are special:
1507
1508       •   ?  matches any single character.
1509
1510       •   * matches any sequence of zero or more characters.
1511
1512       To specify additional patterns, use the --histignore option or set the
1513       MYSQL_HISTIGNORE environment variable. (If both are specified, the
1514       option value takes precedence.) The value should be a list of one or
1515       more colon-separated patterns, which are appended to the default
1516       pattern list.
1517
1518       Patterns specified on the command line might need to be quoted or
1519       escaped to prevent your command interpreter from treating them
1520       specially. For example, to suppress logging for UPDATE and DELETE
1521       statements in addition to statements that refer to passwords, invoke
1522       mysql like this:
1523
1524           mysql --histignore="*UPDATE*:*DELETE*"
1525
1526       Controlling the History File
1527
1528       The .mysql_history file should be protected with a restrictive access
1529       mode because sensitive information might be written to it, such as the
1530       text of SQL statements that contain passwords. See Section 6.1.2.1,
1531       “End-User Guidelines for Password Security”. Statements in the file are
1532       accessible from the mysql client when the up-arrow key is used to
1533       recall the history. See Disabling Interactive History.
1534
1535       If you do not want to maintain a history file, first remove
1536       .mysql_history if it exists. Then use either of the following
1537       techniques to prevent it from being created again:
1538
1539       •   Set the MYSQL_HISTFILE environment variable to /dev/null. To cause
1540           this setting to take effect each time you log in, put it in one of
1541           your shell's startup files.
1542
1543       •   Create .mysql_history as a symbolic link to /dev/null; this need be
1544           done only once:
1545
1546               ln -s /dev/null $HOME/.mysql_history
1547       syslog Logging Characteristics
1548
1549       If the --syslog option is given, mysql writes interactive statements to
1550       the system logging facility. Message logging has the following
1551       characteristics.
1552
1553       Logging occurs at the “information” level. This corresponds to the
1554       LOG_INFO priority for syslog on Unix/Linux syslog capability and to
1555       EVENTLOG_INFORMATION_TYPE for the Windows Event Log. Consult your
1556       system documentation for configuration of your logging capability.
1557
1558       Message size is limited to 1024 bytes.
1559
1560       Messages consist of the identifier MysqlClient followed by these
1561       values:
1562
1563       •   SYSTEM_USER
1564
1565           The operating system user name (login name) or -- if the user is
1566           unknown.
1567
1568       •   MYSQL_USER
1569
1570           The MySQL user name (specified with the --user option) or -- if the
1571           user is unknown.
1572
1573       •   CONNECTION_ID:
1574
1575           The client connection identifier. This is the same as the
1576           CONNECTION_ID() function value within the session.
1577
1578       •   DB_SERVER
1579
1580           The server host or -- if the host is unknown.
1581
1582       •   DB
1583
1584           The default database or -- if no database has been selected.
1585
1586       •   QUERY
1587
1588           The text of the logged statement.
1589
1590       Here is a sample of output generated on Linux by using --syslog. This
1591       output is formatted for readability; each logged message actually takes
1592       a single line.
1593
1594           Mar  7 12:39:25 myhost MysqlClient[20824]:
1595             SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
1596             DB_SERVER:'127.0.0.1', DB:'--', QUERY:'USE test;'
1597           Mar  7 12:39:28 myhost MysqlClient[20824]:
1598             SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
1599             DB_SERVER:'127.0.0.1', DB:'test', QUERY:'SHOW TABLES;'
1600

MYSQL CLIENT SERVER-SIDE HELP

1602           mysql> help search_string
1603
1604       If you provide an argument to the help command, mysql uses it as a
1605       search string to access server-side help from the contents of the MySQL
1606       Reference Manual. The proper operation of this command requires that
1607       the help tables in the mysql database be initialized with help topic
1608       information (see Section 5.1.17, “Server-Side Help Support”).
1609
1610       If there is no match for the search string, the search fails:
1611
1612           mysql> help me
1613           Nothing found
1614           Please try to run 'help contents' for a list of all accessible topics
1615
1616       Use help contents to see a list of the help categories:
1617
1618           mysql> help contents
1619           You asked for help about help category: "Contents"
1620           For more information, type 'help <item>', where <item> is one of the
1621           following categories:
1622              Account Management
1623              Administration
1624              Data Definition
1625              Data Manipulation
1626              Data Types
1627              Functions
1628              Functions and Modifiers for Use with GROUP BY
1629              Geographic Features
1630              Language Structure
1631              Plugins
1632              Storage Engines
1633              Stored Routines
1634              Table Maintenance
1635              Transactions
1636              Triggers
1637
1638       If the search string matches multiple items, mysql shows a list of
1639       matching topics:
1640
1641           mysql> help logs
1642           Many help items for your request exist.
1643           To make a more specific request, please type 'help <item>',
1644           where <item> is one of the following topics:
1645              SHOW
1646              SHOW BINARY LOGS
1647              SHOW ENGINE
1648              SHOW LOGS
1649
1650       Use a topic as the search string to see the help entry for that topic:
1651
1652           mysql> help show binary logs
1653           Name: 'SHOW BINARY LOGS'
1654           Description:
1655           Syntax:
1656           SHOW BINARY LOGS
1657           SHOW MASTER LOGS
1658           Lists the binary log files on the server. This statement is used as
1659           part of the procedure described in [purge-binary-logs], that shows how
1660           to determine which logs can be purged.
1661
1662           mysql> SHOW BINARY LOGS;
1663           +---------------+-----------+-----------+
1664           | Log_name      | File_size | Encrypted |
1665           +---------------+-----------+-----------+
1666           | binlog.000015 |    724935 | Yes       |
1667           | binlog.000016 |    733481 | Yes       |
1668           +---------------+-----------+-----------+
1669
1670       The search string can contain the wildcard characters % and _. These
1671       have the same meaning as for pattern-matching operations performed with
1672       the LIKE operator. For example, HELP rep% returns a list of topics that
1673       begin with rep:
1674
1675           mysql> HELP rep%
1676           Many help items for your request exist.
1677           To make a more specific request, please type 'help <item>',
1678           where <item> is one of the following
1679           topics:
1680              REPAIR TABLE
1681              REPEAT FUNCTION
1682              REPEAT LOOP
1683              REPLACE
1684              REPLACE FUNCTION
1685

EXECUTING SQL STATEMENTS FROM A TEXT FILE

1687       The mysql client typically is used interactively, like this:
1688
1689           mysql db_name
1690
1691       However, it is also possible to put your SQL statements in a file and
1692       then tell mysql to read its input from that file. To do so, create a
1693       text file text_file that contains the statements you wish to execute.
1694       Then invoke mysql as shown here:
1695
1696           mysql db_name < text_file
1697
1698       If you place a USE db_name statement as the first statement in the
1699       file, it is unnecessary to specify the database name on the command
1700       line:
1701
1702           mysql < text_file
1703
1704       If you are already running mysql, you can execute an SQL script file
1705       using the source command or \.  command:
1706
1707           mysql> source file_name
1708           mysql> \. file_name
1709
1710       Sometimes you may want your script to display progress information to
1711       the user. For this you can insert statements like this:
1712
1713           SELECT '<info_to_display>' AS ' ';
1714
1715       The statement shown outputs <info_to_display>.
1716
1717       You can also invoke mysql with the --verbose option, which causes each
1718       statement to be displayed before the result that it produces.
1719
1720       mysql ignores Unicode byte order mark (BOM) characters at the beginning
1721       of input files. Previously, it read them and sent them to the server,
1722       resulting in a syntax error. Presence of a BOM does not cause mysql to
1723       change its default character set. To do that, invoke mysql with an
1724       option such as --default-character-set=utf8mb4.
1725
1726       For more information about batch mode, see Section 3.5, “Using mysql in
1727       Batch Mode”.
1728

MYSQL CLIENT TIPS

1730       This section provides information about techniques for more effective
1731       use of mysql and about mysql operational behavior.
1732
1733       •   Input-Line Editing
1734
1735       •   Disabling Interactive History
1736
1737       •   Unicode Support on Windows
1738
1739       •   Displaying Query Results Vertically
1740
1741       •   Using Safe-Updates Mode (--safe-updates)
1742
1743       •   Disabling mysql Auto-Reconnect
1744
1745       •   mysql Client Parser Versus Server Parser
1746       Input-Line Editing
1747
1748       mysql supports input-line editing, which enables you to modify the
1749       current input line in place or recall previous input lines. For
1750       example, the left-arrow and right-arrow keys move horizontally within
1751       the current input line, and the up-arrow and down-arrow keys move up
1752       and down through the set of previously entered lines.  Backspace
1753       deletes the character before the cursor and typing new characters
1754       enters them at the cursor position. To enter the line, press Enter.
1755
1756       On Windows, the editing key sequences are the same as supported for
1757       command editing in console windows. On Unix, the key sequences depend
1758       on the input library used to build mysql (for example, the libedit or
1759       readline library).
1760
1761       Documentation for the libedit and readline libraries is available
1762       online. To change the set of key sequences permitted by a given input
1763       library, define key bindings in the library startup file. This is a
1764       file in your home directory: .editrc for libedit and .inputrc for
1765       readline.
1766
1767       For example, in libedit, Control+W deletes everything before the
1768       current cursor position and Control+U deletes the entire line. In
1769       readline, Control+W deletes the word before the cursor and Control+U
1770       deletes everything before the current cursor position. If mysql was
1771       built using libedit, a user who prefers the readline behavior for these
1772       two keys can put the following lines in the .editrc file (creating the
1773       file if necessary):
1774
1775           bind "^W" ed-delete-prev-word
1776           bind "^U" vi-kill-line-prev
1777
1778       To see the current set of key bindings, temporarily put a line that
1779       says only bind at the end of .editrc.  mysql shows the bindings when it
1780       starts.  Disabling Interactive History
1781
1782       The up-arrow key enables you to recall input lines from current and
1783       previous sessions. In cases where a console is shared, this behavior
1784       may be unsuitable.  mysql supports disabling the interactive history
1785       partially or fully, depending on the host platform.
1786
1787       On Windows, the history is stored in memory.  Alt+F7 deletes all input
1788       lines stored in memory for the current history buffer. It also deletes
1789       the list of sequential numbers in front of the input lines displayed
1790       with F7 and recalled (by number) with F9. New input lines entered after
1791       you press Alt+F7 repopulate the current history buffer. Clearing the
1792       buffer does not prevent logging to the Windows Event Viewer, if the
1793       --syslog option was used to start mysql. Closing the console window
1794       also clears the current history buffer.
1795
1796       To disable interactive history on Unix, first delete the .mysql_history
1797       file, if it exists (previous entries are recalled otherwise). Then
1798       start mysql with the --histignore="*" option to ignore all new input
1799       lines. To re-enable the recall (and logging) behavior, restart mysql
1800       without the option.
1801
1802       If you prevent the .mysql_history file from being created (see
1803       Controlling the History File) and use --histignore="*" to start the
1804       mysql client, the interactive history recall facility is disabled
1805       fully. Alternatively, if you omit the --histignore option, you can
1806       recall the input lines entered during the current session.  Unicode
1807       Support on Windows
1808
1809       Windows provides APIs based on UTF-16LE for reading from and writing to
1810       the console; the mysql client for Windows is able to use these APIs.
1811       The Windows installer creates an item in the MySQL menu named MySQL
1812       command line client - Unicode. This item invokes the mysql client with
1813       properties set to communicate through the console to the MySQL server
1814       using Unicode.
1815
1816       To take advantage of this support manually, run mysql within a console
1817       that uses a compatible Unicode font and set the default character set
1818       to a Unicode character set that is supported for communication with the
1819       server:
1820
1821        1. Open a console window.
1822
1823        2. Go to the console window properties, select the font tab, and
1824           choose Lucida Console or some other compatible Unicode font. This
1825           is necessary because console windows start by default using a DOS
1826           raster font that is inadequate for Unicode.
1827
1828        3. Execute mysql.exe with the --default-character-set=utf8mb4 (or
1829           utf8mb3) option. This option is necessary because utf16le is one of
1830           the character sets that cannot be used as the client character set.
1831           See the section called “Impermissible Client Character Sets”.
1832
1833       With those changes, mysql uses the Windows APIs to communicate with the
1834       console using UTF-16LE, and communicate with the server using UTF-8.
1835       (The menu item mentioned previously sets the font and character set as
1836       just described.)
1837
1838       To avoid those steps each time you run mysql, you can create a shortcut
1839       that invokes mysql.exe. The shortcut should set the console font to
1840       Lucida Console or some other compatible Unicode font, and pass the
1841       --default-character-set=utf8mb4 (or utf8mb3) option to mysql.exe.
1842
1843       Alternatively, create a shortcut that only sets the console font, and
1844       set the character set in the [mysql] group of your my.ini file:
1845
1846           [mysql]
1847           default-character-set=utf8mb4   # or utf8mb3
1848
1849       Displaying Query Results Vertically
1850
1851       Some query results are much more readable when displayed vertically,
1852       instead of in the usual horizontal table format. Queries can be
1853       displayed vertically by terminating the query with \G instead of a
1854       semicolon. For example, longer text values that include newlines often
1855       are much easier to read with vertical output:
1856
1857           mysql> SELECT * FROM mails WHERE LENGTH(txt) < 300 LIMIT 300,1\G
1858           *************************** 1. row ***************************
1859             msg_nro: 3068
1860                date: 2000-03-01 23:29:50
1861           time_zone: +0200
1862           mail_from: Jones
1863               reply: jones@example.com
1864             mail_to: "John Smith" <smith@example.com>
1865                 sbj: UTF-8
1866                 txt: >>>>> "John" == John Smith writes:
1867           John> Hi.  I think this is a good idea.  Is anyone familiar
1868           John> with UTF-8 or Unicode? Otherwise, I'll put this on my
1869           John> TODO list and see what happens.
1870           Yes, please do that.
1871           Regards,
1872           Jones
1873                file: inbox-jani-1
1874                hash: 190402944
1875           1 row in set (0.09 sec)
1876
1877       Using Safe-Updates Mode (--safe-updates)
1878
1879       For beginners, a useful startup option is --safe-updates (or
1880       --i-am-a-dummy, which has the same effect). Safe-updates mode is
1881       helpful for cases when you might have issued an UPDATE or DELETE
1882       statement but forgotten the WHERE clause indicating which rows to
1883       modify. Normally, such statements update or delete all rows in the
1884       table. With --safe-updates, you can modify rows only by specifying the
1885       key values that identify them, or a LIMIT clause, or both. This helps
1886       prevent accidents. Safe-updates mode also restricts SELECT statements
1887       that produce (or are estimated to produce) very large result sets.
1888
1889       The --safe-updates option causes mysql to execute the following
1890       statement when it connects to the MySQL server, to set the session
1891       values of the sql_safe_updates, sql_select_limit, and max_join_size
1892       system variables:
1893
1894           SET sql_safe_updates=1, sql_select_limit=1000, max_join_size=1000000;
1895
1896       The SET statement affects statement processing as follows:
1897
1898       •   Enabling sql_safe_updates causes UPDATE and DELETE statements to
1899           produce an error if they do not specify a key constraint in the
1900           WHERE clause, or provide a LIMIT clause, or both. For example:
1901
1902               UPDATE tbl_name SET not_key_column=val WHERE key_column=val;
1903               UPDATE tbl_name SET not_key_column=val LIMIT 1;
1904
1905       •   Setting sql_select_limit to 1,000 causes the server to limit all
1906           SELECT result sets to 1,000 rows unless the statement includes a
1907           LIMIT clause.
1908
1909       •   Setting max_join_size to 1,000,000 causes multiple-table SELECT
1910           statements to produce an error if the server estimates it must
1911           examine more than 1,000,000 row combinations.
1912
1913       To specify result set limits different from 1,000 and 1,000,000, you
1914       can override the defaults by using the --select-limit and
1915       --max-join-size options when you invoke mysql:
1916
1917           mysql --safe-updates --select-limit=500 --max-join-size=10000
1918
1919       It is possible for UPDATE and DELETE statements to produce an error in
1920       safe-updates mode even with a key specified in the WHERE clause, if the
1921       optimizer decides not to use the index on the key column:
1922
1923       •   Range access on the index cannot be used if memory usage exceeds
1924           that permitted by the range_optimizer_max_mem_size system variable.
1925           The optimizer then falls back to a table scan. See the section
1926           called “Limiting Memory Use for Range Optimization”.
1927
1928       •   If key comparisons require type conversion, the index may not be
1929           used (see Section 8.3.1, “How MySQL Uses Indexes”). Suppose that an
1930           indexed string column c1 is compared to a numeric value using WHERE
1931           c1 = 2222. For such comparisons, the string value is converted to a
1932           number and the operands are compared numerically (see Section 12.3,
1933           “Type Conversion in Expression Evaluation”), preventing use of the
1934           index. If safe-updates mode is enabled, an error occurs.
1935
1936       As of MySQL 8.0.13, safe-updates mode also includes these behaviors:
1937
1938       •   EXPLAIN with UPDATE and DELETE statements does not produce
1939           safe-updates errors. This enables use of EXPLAIN plus SHOW WARNINGS
1940           to see why an index is not used, which can be helpful in cases such
1941           as when a range_optimizer_max_mem_size violation or type conversion
1942           occurs and the optimizer does not use an index even though a key
1943           column was specified in the WHERE clause.
1944
1945       •   When a safe-updates error occurs, the error message includes the
1946           first diagnostic that was produced, to provide information about
1947           the reason for failure. For example, the message may indicate that
1948           the range_optimizer_max_mem_size value was exceeded or type
1949           conversion occurred, either of which can preclude use of an index.
1950
1951       •   For multiple-table deletes and updates, an error is produced with
1952           safe updates enabled only if any target table uses a table scan.
1953       Disabling mysql Auto-Reconnect
1954
1955       If the mysql client loses its connection to the server while sending a
1956       statement, it immediately and automatically tries to reconnect once to
1957       the server and send the statement again. However, even if mysql
1958       succeeds in reconnecting, your first connection has ended and all your
1959       previous session objects and settings are lost: temporary tables, the
1960       autocommit mode, and user-defined and session variables. Also, any
1961       current transaction rolls back. This behavior may be dangerous for you,
1962       as in the following example where the server was shut down and
1963       restarted between the first and second statements without you knowing
1964       it:
1965
1966           mysql> SET @a=1;
1967           Query OK, 0 rows affected (0.05 sec)
1968           mysql> INSERT INTO t VALUES(@a);
1969           ERROR 2006: MySQL server has gone away
1970           No connection. Trying to reconnect...
1971           Connection id:    1
1972           Current database: test
1973           Query OK, 1 row affected (1.30 sec)
1974           mysql> SELECT * FROM t;
1975           +------+
1976           | a    |
1977           +------+
1978           | NULL |
1979           +------+
1980           1 row in set (0.05 sec)
1981
1982       The @a user variable has been lost with the connection, and after the
1983       reconnection it is undefined. If it is important to have mysql
1984       terminate with an error if the connection has been lost, you can start
1985       the mysql client with the --skip-reconnect option.
1986
1987       For more information about auto-reconnect and its effect on state
1988       information when a reconnection occurs, see Automatic Reconnection
1989       Control[5].  mysql Client Parser Versus Server Parser
1990
1991       The mysql client uses a parser on the client side that is not a
1992       duplicate of the complete parser used by the mysqld server on the
1993       server side. This can lead to differences in treatment of certain
1994       constructs. Examples:
1995
1996       •   The server parser treats strings delimited by " characters as
1997           identifiers rather than as plain strings if the ANSI_QUOTES SQL
1998           mode is enabled.
1999
2000           The mysql client parser does not take the ANSI_QUOTES SQL mode into
2001           account. It treats strings delimited by ", ', and ` characters the
2002           same, regardless of whether ANSI_QUOTES is enabled.
2003
2004       •   Within /*! ... */ and /*+ ... */ comments, the mysql client parser
2005           interprets short-form mysql commands. The server parser does not
2006           interpret them because these commands have no meaning on the server
2007           side.
2008
2009           If it is desirable for mysql not to interpret short-form commands
2010           within comments, a partial workaround is to use the --binary-mode
2011           option, which causes all mysql commands to be disabled except \C
2012           and \d in noninteractive mode (for input piped to mysql or loaded
2013           using the source command).
2014
2016       Copyright © 1997, 2022, Oracle and/or its affiliates.
2017
2018       This documentation is free software; you can redistribute it and/or
2019       modify it only under the terms of the GNU General Public License as
2020       published by the Free Software Foundation; version 2 of the License.
2021
2022       This documentation is distributed in the hope that it will be useful,
2023       but WITHOUT ANY WARRANTY; without even the implied warranty of
2024       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2025       General Public License for more details.
2026
2027       You should have received a copy of the GNU General Public License along
2028       with the program; if not, write to the Free Software Foundation, Inc.,
2029       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see
2030       http://www.gnu.org/licenses/.
2031
2032

NOTES

2034        1. MySQL Shell 8.0
2035           https://dev.mysql.com/doc/mysql-shell/8.0/en/
2036
2037        2. C API Basic Data Structures
2038           https://dev.mysql.com/doc/c-api/8.0/en/c-api-data-structures.html
2039
2040        3. Multiple Statement Execution Support
2041           https://dev.mysql.com/doc/c-api/8.0/en/c-api-multiple-queries.html
2042
2043        4. mysql_change_user()
2044           https://dev.mysql.com/doc/c-api/8.0/en/mysql-change-user.html
2045
2046        5. Automatic Reconnection Control
2047           https://dev.mysql.com/doc/c-api/8.0/en/c-api-auto-reconnect.html
2048

SEE ALSO

2050       For more information, please refer to the MySQL Reference Manual, which
2051       may already be installed locally and which is also available online at
2052       http://dev.mysql.com/doc/.
2053

AUTHOR

2055       Oracle Corporation (http://dev.mysql.com/).
2056
2057
2058
2059MySQL 8.0                         08/29/2022                          MYSQL(1)
Impressum