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 demonistrates 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: athenticator
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. Other MySQL client programs do not support it.
394
395           For related information, see the section called “Using FIDO
396           Authentication”.
397
398--force, -f Continue even if an SQL error occurs.
399
400--get-server-public-key Request from the server the public key
401           required for RSA key pair-based password exchange. This option
402           applies to clients that authenticate with the caching_sha2_password
403           authentication plugin. For that plugin, the server does not send
404           the public key unless requested. This option is ignored for
405           accounts that do not authenticate with that plugin. It is also
406           ignored if RSA-based password exchange is not used, as is the case
407           when the client connects to the server using a secure connection.
408
409           If --server-public-key-path=file_name is given and specifies a
410           valid public key file, it takes precedence over
411           --get-server-public-key.
412
413           For information about the caching_sha2_password plugin, see
414           Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
415
416--histignore A list of one or more colon-separated patterns
417           specifying statements to ignore for logging purposes. These
418           patterns are added to the default pattern list
419           ("*IDENTIFIED*:*PASSWORD*"). The value specified for this option
420           affects logging of statements written to the history file, and to
421           syslog if the --syslog option is given. For more information, see
422           the section called “MYSQL CLIENT LOGGING”.
423
424--host=host_name, -h host_name Connect to the MySQL server on the
425           given host.
426
427           The --dns-srv-name option takes precedence over the --host option
428           if both are given.  --dns-srv-name causes connection establishment
429           to use the mysql_real_connect_dns_srv() C API function rather than
430           mysql_real_connect(). However, if the connect command is
431           subsequently used at runtime and specifies a host name argument,
432           that host name takes precedence over any --dns-srv-name option
433           given at mysql startup to specify a DNS SRV record.
434
435--html, -H Produce HTML output.
436
437--ignore-spaces, -i Ignore spaces after function names. The effect
438           of this is described in the discussion for the IGNORE_SPACE SQL
439           mode (see Section 5.1.11, “Server SQL Modes”).
440
441--init-command=str SQL statement to execute after connecting to the
442           server. If auto-reconnect is enabled, the statement is executed
443           again after reconnection occurs.
444
445--line-numbers Write line numbers for errors. Disable this with
446           --skip-line-numbers.
447
448--load-data-local-dir=dir_name This option affects the client-side
449           LOCAL capability for LOAD DATA operations. It specifies the
450           directory in which files named in LOAD DATA LOCAL statements must
451           be located. The effect of --load-data-local-dir depends on whether
452           LOCAL data loading is enabled or disabled:
453
454           •   If LOCAL data loading is enabled, either by default in the
455               MySQL client library or by specifying --local-infile[=1], the
456               --load-data-local-dir option is ignored.
457
458           •   If LOCAL data loading is disabled, either by default in the
459               MySQL client library or by specifying --local-infile=0, the
460               --load-data-local-dir option applies.
461
462           When --load-data-local-dir applies, the option value designates the
463           directory in which local data files must be located. Comparison of
464           the directory path name and the path name of files to be loaded is
465           case-sensitive regardless of the case sensitivity of the underlying
466           file system. If the option value is the empty string, it names no
467           directory, with the result that no files are permitted for local
468           data loading.
469
470           For example, to explicitly disable local data loading except for
471           files located in the /my/local/data directory, invoke mysql like
472           this:
473
474               mysql --local-infile=0 --load-data-local-dir=/my/local/data
475
476           When both --local-infile and --load-data-local-dir are given, the
477           order in which they are given does not matter.
478
479           Successful use of LOCAL load operations within mysql also requires
480           that the server permits local loading; see Section 6.1.6, “Security
481           Considerations for LOAD DATA LOCAL”
482
483           The --load-data-local-dir option was added in MySQL 8.0.21.
484
485--local-infile[={0|1}] By default, LOCAL capability for LOAD DATA
486           is determined by the default compiled into the MySQL client
487           library. To enable or disable LOCAL data loading explicitly, use
488           the --local-infile option. When given with no value, the option
489           enables LOCAL data loading. When given as --local-infile=0 or
490           --local-infile=1, the option disables or enables LOCAL data
491           loading.
492
493           If LOCAL capability is disabled, the --load-data-local-dir option
494           can be used to permit restricted local loading of files located in
495           a designated directory.
496
497           Successful use of LOCAL load operations within mysql also requires
498           that the server permits local loading; see Section 6.1.6, “Security
499           Considerations for LOAD DATA LOCAL”
500
501--login-path=name Read options from the named login path in the
502           .mylogin.cnf login path file. A “login path” is an option group
503           containing options that specify which MySQL server to connect to
504           and which account to authenticate as. To create or modify a login
505           path file, use the mysql_config_editor utility. See
506           mysql_config_editor(1).
507
508           For additional information about this and other option-file
509           options, see Section 4.2.2.3, “Command-Line Options that Affect
510           Option-File Handling”.
511
512--max-allowed-packet=value The maximum size of the buffer for
513           client/server communication. The default is 16MB, the maximum is
514           1GB.
515
516--max-join-size=value The automatic limit for rows in a join when
517           using --safe-updates. (Default value is 1,000,000.)
518
519--named-commands, -G Enable named mysql commands. Long-format
520           commands are permitted, not just short-format commands. For
521           example, quit and \q both are recognized. Use --skip-named-commands
522           to disable named commands. See the section called “MYSQL CLIENT
523           COMMANDS”.
524
525--net-buffer-length=value The buffer size for TCP/IP and socket
526           communication. (Default value is 16KB.)
527
528--network-namespace=name The network namespace to use for TCP/IP
529           connections. If omitted, the connection uses the default (global)
530           namespace. For information about network namespaces, see
531           Section 5.1.14, “Network Namespace Support”.
532
533           This option was added in MySQL 8.0.22. It is available only on
534           platforms that implement network namespace support.
535
536--no-auto-rehash, -A This has the same effect as
537           --skip-auto-rehash. See the description for --auto-rehash.
538
539--no-beep, -b Do not beep when errors occur.
540
541--no-defaults Do not read any option files. If program startup
542           fails due to reading unknown options from an option file,
543           --no-defaults can be used to prevent them from being read.
544
545           The exception is that the .mylogin.cnf file is read in all cases,
546           if it exists. This permits passwords to be specified in a safer way
547           than on the command line even when --no-defaults is used. To create
548           .mylogin.cnf, use the mysql_config_editor utility. See
549           mysql_config_editor(1).
550
551           For additional information about this and other option-file
552           options, see Section 4.2.2.3, “Command-Line Options that Affect
553           Option-File Handling”.
554
555--one-database, -o Ignore statements except those that occur while
556           the default database is the one named on the command line. This
557           option is rudimentary and should be used with care. Statement
558           filtering is based only on USE statements.
559
560           Initially, mysql executes statements in the input because
561           specifying a database db_name on the command line is equivalent to
562           inserting USE db_name at the beginning of the input. Then, for each
563           USE statement encountered, mysql accepts or rejects following
564           statements depending on whether the database named is the one on
565           the command line. The content of the statements is immaterial.
566
567           Suppose that mysql is invoked to process this set of statements:
568
569               DELETE FROM db2.t2;
570               USE db2;
571               DROP TABLE db1.t1;
572               CREATE TABLE db1.t1 (i INT);
573               USE db1;
574               INSERT INTO t1 (i) VALUES(1);
575               CREATE TABLE db2.t1 (j INT);
576
577           If the command line is mysql --force --one-database db1, mysql
578           handles the input as follows:
579
580           •   The DELETE statement is executed because the default database
581               is db1, even though the statement names a table in a different
582               database.
583
584           •   The DROP TABLE and CREATE TABLE statements are not executed
585               because the default database is not db1, even though the
586               statements name a table in db1.
587
588           •   The INSERT and CREATE TABLE statements are executed because the
589               default database is db1, even though the CREATE TABLE statement
590               names a table in a different database.
591
592--pager[=command] Use the given command for paging query output. If
593           the command is omitted, the default pager is the value of your
594           PAGER environment variable. Valid pagers are less, more, cat [>
595           filename], and so forth. This option works only on Unix and only in
596           interactive mode. To disable paging, use --skip-pager.  the section
597           called “MYSQL CLIENT COMMANDS”, discusses output paging further.
598
599--password[=password], -p[password] The password of the MySQL
600           account used for connecting to the server. The password value is
601           optional. If not given, mysql prompts for one. If given, there must
602           be no space between --password= or -p and the password following
603           it. If no password option is specified, the default is to send no
604           password.
605
606           Specifying a password on the command line should be considered
607           insecure. To avoid giving the password on the command line, use an
608           option file. See Section 6.1.2.1, “End-User Guidelines for Password
609           Security”.
610
611           To explicitly specify that there is no password and that mysql
612           should not prompt for one, use the --skip-password option.
613
614--password1[=pass_val] The password for multifactor authentication
615           factor 1 of the MySQL account used for connecting to the server.
616           The password value is optional. If not given, mysql prompts for
617           one. If given, there must be no space between --password1= and the
618           password following it. If no password option is specified, the
619           default is to send no password.
620
621           Specifying a password on the command line should be considered
622           insecure. To avoid giving the password on the command line, use an
623           option file. See Section 6.1.2.1, “End-User Guidelines for Password
624           Security”.
625
626           To explicitly specify that there is no password and that mysql
627           should not prompt for one, use the --skip-password1 option.
628
629           --password1 and --password are synonymous, as are --skip-password1
630           and --skip-password.
631
632--password2[=pass_val] The password for multifactor authentication
633           factor 2 of the MySQL account used for connecting to the server.
634           The semantics of this option are similar to the semantics for
635           --password1; see the description of that option for details.
636
637--password3[=pass_val] The password for multifactor authentication
638           factor 3 of the MySQL account used for connecting to the server.
639           The semantics of this option are similar to the semantics for
640           --password1; see the description of that option for details.
641
642--pipe, -W On Windows, connect to the server using a named pipe.
643           This option applies only if the server was started with the
644           named_pipe system variable enabled to support named-pipe
645           connections. In addition, the user making the connection must be a
646           member of the Windows group specified by the
647           named_pipe_full_access_group system variable.
648
649--plugin-dir=dir_name The directory in which to look for plugins.
650           Specify this option if the --default-auth option is used to specify
651           an authentication plugin but mysql does not find it. See
652           Section 6.2.17, “Pluggable Authentication”.
653
654--port=port_num, -P port_num For TCP/IP connections, the port
655           number to use.
656
657--print-defaults Print the program name and all options that it
658           gets from option files.
659
660           For additional information about this and other option-file
661           options, see Section 4.2.2.3, “Command-Line Options that Affect
662           Option-File Handling”.
663
664--prompt=format_str Set the prompt to the specified format. The
665           default is mysql>. The special sequences that the prompt can
666           contain are described in the section called “MYSQL CLIENT
667           COMMANDS”.
668
669--protocol={TCP|SOCKET|PIPE|MEMORY} The transport protocol to use
670           for connecting to the server. It is useful when the other
671           connection parameters normally result in use of a protocol other
672           than the one you want. For details on the permissible values, see
673           Section 4.2.7, “Connection Transport Protocols”.
674
675--quick, -q Do not cache each query result, print each row as it is
676           received. This may slow down the server if the output is suspended.
677           With this option, mysql does not use the history file.
678
679--raw, -r For tabular output, the “boxing” around columns enables
680           one column value to be distinguished from another. For nontabular
681           output (such as is produced in batch mode or when the --batch or
682           --silent option is given), special characters are escaped in the
683           output so they can be identified easily. Newline, tab, NUL, and
684           backslash are written as \n, \t, \0, and \\. The --raw option
685           disables this character escaping.
686
687           The following example demonstrates tabular versus nontabular output
688           and the use of raw mode to disable escaping:
689
690               % mysql
691               mysql> SELECT CHAR(92);
692               +----------+
693               | CHAR(92) |
694               +----------+
695               | \        |
696               +----------+
697               % mysql -s
698               mysql> SELECT CHAR(92);
699               CHAR(92)
700               \\
701               % mysql -s -r
702               mysql> SELECT CHAR(92);
703               CHAR(92)
704               \
705
706--reconnect If the connection to the server is lost, automatically
707           try to reconnect. A single reconnect attempt is made each time the
708           connection is lost. To suppress reconnection behavior, use
709           --skip-reconnect.
710
711--safe-updates, --i-am-a-dummy, -U If this option is enabled,
712           UPDATE and DELETE statements that do not use a key in the WHERE
713           clause or a LIMIT clause produce an error. In addition,
714           restrictions are placed on SELECT statements that produce (or are
715           estimated to produce) very large result sets. If you have set this
716           option in an option file, you can use --skip-safe-updates on the
717           command line to override it. For more information about this
718           option, see Using Safe-Updates Mode (--safe-updates).
719
720--select-limit=value The automatic limit for SELECT statements when
721           using --safe-updates. (Default value is 1,000.)
722
723--server-public-key-path=file_name The path name to a file in PEM
724           format containing a client-side copy of the public key required by
725           the server for RSA key pair-based password exchange. This option
726           applies to clients that authenticate with the sha256_password or
727           caching_sha2_password authentication plugin. This option is ignored
728           for accounts that do not authenticate with one of those plugins. It
729           is also ignored if RSA-based password exchange is not used, as is
730           the case when the client connects to the server using a secure
731           connection.
732
733           If --server-public-key-path=file_name is given and specifies a
734           valid public key file, it takes precedence over
735           --get-server-public-key.
736
737           For sha256_password, this option applies only if MySQL was built
738           using OpenSSL.
739
740           For information about the sha256_password and caching_sha2_password
741           plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”,
742           and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”.
743
744--shared-memory-base-name=name On Windows, the shared-memory name
745           to use for connections made using shared memory to a local server.
746           The default value is MYSQL. The shared-memory name is
747           case-sensitive.
748
749           This option applies only if the server was started with the
750           shared_memory system variable enabled to support shared-memory
751           connections.
752
753--show-warnings Cause warnings to be shown after each statement if
754           there are any. This option applies to interactive and batch mode.
755
756--sigint-ignore Ignore SIGINT signals (typically the result of
757           typing Control+C).
758
759           Without this option, typing Control+C interrupts the current
760           statement if there is one, or cancels any partial input line
761           otherwise.
762
763--silent, -s Silent mode. Produce less output. This option can be
764           given multiple times to produce less and less output.
765
766           This option results in nontabular output format and escaping of
767           special characters. Escaping may be disabled by using raw mode; see
768           the description for the --raw option.
769
770--skip-column-names, -N Do not write column names in results.
771
772--skip-line-numbers, -L Do not write line numbers for errors.
773           Useful when you want to compare result files that include error
774           messages.
775
776--socket=path, -S path For connections to localhost, the Unix
777           socket file to use, or, on Windows, the name of the named pipe to
778           use.
779
780           On Windows, this option applies only if the server was started with
781           the named_pipe system variable enabled to support named-pipe
782           connections. In addition, the user making the connection must be a
783           member of the Windows group specified by the
784           named_pipe_full_access_group system variable.
785
786--ssl* Options that begin with --ssl specify whether to connect to
787           the server using encryption and indicate where to find SSL keys and
788           certificates. See the section called “Command Options for Encrypted
789           Connections”.
790
791--ssl-fips-mode={OFF|ON|STRICT} Controls whether to enable FIPS
792           mode on the client side. The --ssl-fips-mode option differs from
793           other --ssl-xxx options in that it is not used to establish
794           encrypted connections, but rather to affect which cryptographic
795           operations to permit. See Section 6.8, “FIPS Support”.
796
797           These --ssl-fips-mode values are permitted:
798
799           •   OFF: Disable FIPS mode.
800
801           •   ON: Enable FIPS mode.
802
803           •   STRICT: Enable “strict” FIPS mode.
804
805
806               Note
807               If the OpenSSL FIPS Object Module is not available, the only
808               permitted value for --ssl-fips-mode is OFF. In this case,
809               setting --ssl-fips-mode to ON or STRICT causes the client to
810               produce a warning at startup and to operate in non-FIPS mode.
811
812--syslog, -j This option causes mysql to send interactive
813           statements to the system logging facility. On Unix, this is syslog;
814           on Windows, it is the Windows Event Log. The destination where
815           logged messages appear is system dependent. On Linux, the
816           destination is often the /var/log/messages file.
817
818           Here is a sample of output generated on Linux by using --syslog.
819           This output is formatted for readability; each logged message
820           actually takes a single line.
821
822               Mar  7 12:39:25 myhost MysqlClient[20824]:
823                 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
824                 DB_SERVER:'127.0.0.1', DB:'--', QUERY:'USE test;'
825               Mar  7 12:39:28 myhost MysqlClient[20824]:
826                 SYSTEM_USER:'oscar', MYSQL_USER:'my_oscar', CONNECTION_ID:23,
827                 DB_SERVER:'127.0.0.1', DB:'test', QUERY:'SHOW TABLES;'
828
829           For more information, see the section called “MYSQL CLIENT
830           LOGGING”.
831
832--table, -t Display output in table format. This is the default for
833           interactive use, but can be used to produce table output in batch
834           mode.
835
836--tee=file_name Append a copy of output to the given file. This
837           option works only in interactive mode.  the section called “MYSQL
838           CLIENT COMMANDS”, discusses tee files further.
839
840--tls-ciphersuites=ciphersuite_list The permissible ciphersuites
841           for encrypted connections that use TLSv1.3. The value is a list of
842           one or more colon-separated ciphersuite names. The ciphersuites
843           that can be named for this option depend on the SSL library used to
844           compile MySQL. For details, see Section 6.3.2, “Encrypted
845           Connection TLS Protocols and Ciphers”.
846
847           This option was added in MySQL 8.0.16.
848
849--tls-version=protocol_list The permissible TLS protocols for
850           encrypted connections. The value is a list of one or more
851           comma-separated protocol names. The protocols that can be named for
852           this option depend on the SSL library used to compile MySQL. For
853           details, see Section 6.3.2, “Encrypted Connection TLS Protocols and
854           Ciphers”.
855
856--unbuffered, -n Flush the buffer after each query.
857
858--user=user_name, -u user_name The user name of the MySQL account
859           to use for connecting to the server.
860
861--verbose, -v Verbose mode. Produce more output about what the
862           program does. This option can be given multiple times to produce
863           more and more output. (For example, -v -v -v produces table output
864           format even in batch mode.)
865
866--version, -V Display version information and exit.
867
868--vertical, -E Print query output rows vertically (one line per
869           column value). Without this option, you can specify vertical output
870           for individual statements by terminating them with \G.
871
872--wait, -w If the connection cannot be established, wait and retry
873           instead of aborting.
874
875--xml, -X Produce XML output.
876
877               <field name="column_name">NULL</field>
878
879           The output when --xml is used with mysql matches that of mysqldump
880           --xml. See mysqldump(1), for details.
881
882           The XML output also uses an XML namespace, as shown here:
883
884               $> mysql --xml -uroot -e "SHOW VARIABLES LIKE 'version%'"
885               <?xml version="1.0"?>
886               <resultset statement="SHOW VARIABLES LIKE 'version%'" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
887               <row>
888               <field name="Variable_name">version</field>
889               <field name="Value">5.0.40-debug</field>
890               </row>
891               <row>
892               <field name="Variable_name">version_comment</field>
893               <field name="Value">Source distribution</field>
894               </row>
895               <row>
896               <field name="Variable_name">version_compile_machine</field>
897               <field name="Value">i686</field>
898               </row>
899               <row>
900               <field name="Variable_name">version_compile_os</field>
901               <field name="Value">suse-linux-gnu</field>
902               </row>
903               </resultset>
904
905--zstd-compression-level=level The compression level to use for
906           connections to the server that use the zstd compression algorithm.
907           The permitted levels are from 1 to 22, with larger values
908           indicating increasing levels of compression. The default zstd
909           compression level is 3. The compression level setting has no effect
910           on connections that do not use zstd compression.
911
912           For more information, see Section 4.2.8, “Connection Compression
913           Control”.
914
915           This option was added in MySQL 8.0.18.
916

MYSQL CLIENT COMMANDS

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

MYSQL CLIENT LOGGING

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

MYSQL CLIENT SERVER-SIDE HELP

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

EXECUTING SQL STATEMENTS FROM A TEXT FILE

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

MYSQL CLIENT TIPS

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

NOTES

2017        1. MySQL Shell 8.0
2018           https://dev.mysql.com/doc/mysql-shell/8.0/en/
2019
2020        2. C API Basic Data Structures
2021           https://dev.mysql.com/doc/c-api/8.0/en/c-api-data-structures.html
2022
2023        3. Multiple Statement Execution Support
2024           https://dev.mysql.com/doc/c-api/8.0/en/c-api-multiple-queries.html
2025
2026        4. mysql_change_user()
2027           https://dev.mysql.com/doc/c-api/8.0/en/mysql-change-user.html
2028
2029        5. Automatic Reconnection Control
2030           https://dev.mysql.com/doc/c-api/8.0/en/c-api-auto-reconnect.html
2031

SEE ALSO

2033       For more information, please refer to the MySQL Reference Manual, which
2034       may already be installed locally and which is also available online at
2035       http://dev.mysql.com/doc/.
2036

AUTHOR

2038       Oracle Corporation (http://dev.mysql.com/).
2039
2040
2041
2042MySQL 8.0                         11/26/2021                          MYSQL(1)
Impressum